Development

Allinix is built using a modern tech stack and follows best practices for software development. This document provides an overview of the development setup and key components of the Allinix project.

Tech Stack

• Frontend: Next.js 13 + TypeScript

• Backend: Python/FastAPI

• Database: SQLite/PostgreSQL

• Styling: Tailwind CSS

• Authentication: Next-Auth.js

• State Management: Zustand

• AI Integration: LangChain

Project Structure

The Allinix project is organized into the following main directories:

• next/: Contains the Next.js frontend code.

• platform/: Contains the Python backend code.

• docs/: Contains the project documentation.

Development Setup

1. Clone the repository:

   git clone https://github.com/Allinix-Labs/Allinix.git
   cd Allinix

2. Install dependencies:

   npm install

3. Set up the backend:

   cd platform
   poetry install

4. Configure environment variables:

   • Create a .env file in the project root.

   • Add the required environment variables (e.g., API keys).

5. Start the development server:

   npm run dev

Contributing

We welcome contributions from the community! To contribute to Allinix:

1. Fork the repository.

2. Create a new branch for your feature or bug fix.

3. Make your changes and commit them with descriptive messages.

4. Push your changes to your forked repository.

5. Open a pull request to the main Allinix repository.

Please make sure to follow the project's coding conventions and write tests for your changes.

Additional Resources

• Next.js Documentation

• FastAPI Documentation

• Tailwind CSS Documentation

• Zustand Documentation

• LangChain Documentation

Happy coding! 💻✨