Organiz is a project management application that allows users to manage their projects, tasks, and categories efficiently. This README provides instructions on how to set up and run the application.
Before starting, ensure you have the following installed:
The easiest way to launch the application is with Docker Compose.
-
Clone the repository:
git clone https://github.com/Pink0s/OrganiZ cd organiz
-
Start the application:
docker compose up -d --build
-
Access the application:
- Frontend: http://localhost
- swagger API: http://localhost/api/swagger
That's it! The application is now running.
If you prefer to run the application manually, follow these steps:
You need to set up .env
files for both the frontend and backend.
- Edit the
.env
files and provide the required configuration:- For the backend (
organiz_api/.env
), include database and API URL. - For the frontend (
organiz_front/.env
), include the API URL for the backend.
- For the backend (
-
Install dependencies and start the backend API:
cd organiz_api npm install npm run dev
-
Open a new terminal and start the frontend:
cd organiz_front npm install npm run dev
- To stop the application when using Docker Compose:
docker compose down