Introduction
Welcome to the Arke documentation!
What is Arke?
Arke is a All-in-one framework for building full-stack web applications. You use can use React/Next.js with Arke.js packages to build user interfaces on frontend, and Elixir with Arke Hex packages for create a complete backend solution with authentication, autogenerated Rest API, and a lot of more.
Arke is born to helps developers to create complex applications faster by automatically hiding and managing the "behind the scenes" of work. This allows you to focus on building your solutions instead of spending time on repetitive functionality as CRUD, Apis.
Whether you're an individual developer or part of a larger team, Arke can help you build fast solutions.
Main Features
| Feature | Description |
|---|---|
| Multi-tenant | Maintain strict data isolation between tenants to safeguard and client's information. Manage your application with multiple environments like Dev/Staging/Production |
| Authentication | A robust and seamless solution for securing your applications with ease. Provide user registration, credentials and social login, password management and 2FA system |
| Members and Permissions | Comprehensive solution for access control. Can define user roles, assign permissions, and control access to various resources, ensuring the security and integrity of the applications. |
| Automatic CRUD system | An Automatic CRUD (Create, Read, Update, Delete) System in Arke simplifies and accelerates the development process by automating the generation of basic CRUD operations for database entities |
| Autogenerated API | An Autogenerated API streamlines the process of exposing database entities as RESTful endpoints, enabling seamless integration with frontend applications through a dedicated Client |
| Topology relations | Facilitates the establishment and management of hierarchical relationships between data entities, enabling the creation of parent-child structures within the application's data model |
How to Use These Docs
On the left side of the screen, you'll find the docs navbar. The pages of the docs are organized sequentially, from basic to advanced, so you can follow them step-by-step when building your application. However, you can read them in any order or skip to the pages that apply to your use case.
On the right side of the screen, you'll see a table of contents that makes it easier to navigate between sections of a page. If you need to quickly find a page, you can use the search bar at the top, or the search shortcut (Ctrl+K or Cmd+K).
To get started, checkout the Installation guide.
Pre-Requisite Knowledge
Although our docs are designed to be beginner-friendly, we need to establish a baseline so that the docs can stay focused on Arke functionality. We'll make sure to provide links to relevant documentation whenever we introduce a new concept.
To get the most out of our docs, it's recommended that you have a intermediate understanding of React and Next.js for the frontend part and Elixir for Backend.
If you need to brush up on your skills, check out the following links, which will introduce you to the fundamentals:
| Stack | Description |
|---|---|
| React (opens in a new tab) | React is a powerful JavaScript library for building interactive user interfaces and dynamic web applications. |
| Next.js (opens in a new tab) | Next.js is a React framework for building full-stack web applications. You use React Components to build user interfaces, and Next.js for additional features and optimizations. |
| TailwindCSS (opens in a new tab) | Tailwind CSS is a utility-first CSS framework that empowers developers to build modern, responsive web interfaces with unparalleled flexibility and efficiency. |
| Elixir (opens in a new tab) | Elixir is a dynamic, functional programming language built on the Erlang virtual machine (BEAM) known for its scalability, fault tolerance, and concurrency model. |
| Phoenix Framework (opens in a new tab) | Phoenix is a web framework built with the Elixir programming language, designed for building highly scalable and performant web applications. |
Join our community
If you have questions about anything related to Arke, you're always welcome to ask our community on Linkedin (opens in a new tab) GitHub (opens in a new tab), Discord (opens in a new tab).