Skip to content

Pink0s/OrganiZ

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Organiz Project

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.

Database Schema

Database schema

Prerequisites

Before starting, ensure you have the following installed:

Running the Application

Option 1: Using Docker Compose (Recommended)

The easiest way to launch the application is with Docker Compose.

  1. Clone the repository:

    git clone https://github.com/Pink0s/OrganiZ
    cd organiz
  2. Start the application:

    docker compose up -d --build
  3. Access the application:

That's it! The application is now running.


Option 2: Running Manually

If you prefer to run the application manually, follow these steps:

Step 1: Prepare .env Files

You need to set up .env files for both the frontend and backend.

  1. 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.

Step 2: Install Dependencies and Start Services

  1. Install dependencies and start the backend API:

    cd organiz_api
    npm install
    npm run dev
  2. Open a new terminal and start the frontend:

    cd organiz_front
    npm install
    npm run dev

Additional Notes

  • To stop the application when using Docker Compose:
    docker compose down

About

A Simple project management application.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages