Eduflipo System

Welcome to Eduflipo System, a project that uses NestJS for the backend and React for the frontend.

Running the Project

Clone the Project

Clone the project from the repository.

Running the backend

Navigate to the backend folder:

cd eduflipo-system

Install dependencies:

npm install

Clone the .env.template file and rename it to .env, then modify the environment variables as needed.
Start the database:

docker-compose up -d

Start the server:

npm run start:dev

Running the frontend

Navigate to the frontend folder:

cd eduflipo-frontend

Install dependencies:

npm install

Start the application:

npm start

Things to Note

Make sure the backend and frontend are running on the following ports:

BACKEND_PORT=3000
FRONTEND_PORT=5173

If you want to change any of the ports, make sure to update the corresponding files in the project.

Visit the backend documentation in your browser:

http://localhost:3000/api

If you have any questions or suggestions, please do not hesitate to contact me.

Potential Issues

When the option synchronize: true is activated in the backend's app.module.ts file, the database is created and related in MySQL. However, if there is existing data in the database and the application is restarted, unique fields are cleared. This behavior is not suitable for production. If you encounter issues, please comment out line 20 in app.module.ts to prevent this behavior.

Common Errors

Database Connection Error: Verify your database configuration and ensure the database server is running. If you have a local MySQL database, ensure it is operational or stop the service to free up the default port.
Dependency Installation Error: Ensure all dependencies are correctly installed using npm install.
Port Conflict Error: Ensure that the specified ports for the backend and frontend are not in use by other applications.
Environment Configuration Error: Check your environment variables and configuration files for any errors or missing values.

CamiloCortesM/EduFlipo