This project is a foundational infrastructure built with Next.js in the frontend and a combination of Node.js and TypeORM in the backend. It offers a solid starting point for modern web applications with a clean and efficient architecture.
- Frontend: Next.js-based application in the
frontend
folder. - Backend: Node.js application using TypeORM in the
backend
folder.
The frontend includes reusable components, global style configurations, and a default theme setup.
The backend provides a robust and scalable API, with controllers, entities, middlewares, and more.
-
Clone the Repository: Clone the project to your local machine.
-
Install Dependencies:
- Run
installProject.sh
for a first-time setup. - Or navigate to each of
frontend
andbackend
folders and runyarn install
.
- Run
-
Configure Environment:
- Create a
.env
file in thebackend
folder based on the.env.example
template. - Adjust database settings (
DB_TYPE
,DB_HOST
, etc.) according to your local database setup.
- Create a
-
Start the Application:
- In the
frontend
folder, runyarn dev
to start the frontend. - In the
backend
folder, runyarn dev
to start the backend.
- In the
-
Configure Environment for Docker:
- Ensure
DB_HOST
in your.env
file is set to the service name of the database indocker-compose.yml
(usuallydb
). - Set other environment variables as required.
- Ensure
-
Start with Docker Compose:
- Run
docker-compose up
in the root directory to start both frontend and backend in containers.
- Run
Contributions are welcome! Feel free to fork the project, make changes, and open a pull request.