This repository contains an Express Node.js server that serves as a backend for your application. It provides a foundation for building robust and scalable web applications using the Express framework and Clean Architecture Design.
Prerequisites Before running the server, ensure that you have the following frameworks installed on your system and resources ready :
- Node.js (version latest)
- yarn (Package Manager)
- AWS cognito identity provider
- MongoDB server
- OpenAI API
Follow these steps to get the server up and running:
yarn build
# then
yarn start:dev
# or
yarn start:prodThis will start the server on http://localhost:3000. Open http://localhost:3000 with your browser to see the result for healthcheck. Postman [https://www.postman.com/] to run test on api routes
You can modify the server configuration by editing the config.ts. This file contains various settings such as port number, database connection details, API keys, etc. You can start by creating .env with the required variables in the config.ts
To learn more about how to change for formatting on the current loggings, take a look at the following resources:
- https://github.com/winstonjs/winston - learn about custom format loggings.
.
├── app
| ├── src
│ ├── config
│ ├── data
│ ├── domain
│ ├── infrastructure
│ ├── presentation
│ └── utils
├── test.ts
├── main.ts
└── server.ts
To learn more about Clean architecture, take a look at the following resources:
- [Architecture] (https://merlino.agency/blog/clean-architecture-in-express-js-applications) - learn about clean architecture implementations.
app: This directory contains the core application logic. config: Holds configuration files and environment variables. It allows the application's settings to be easily modified without changing the code. data: Contains files related to the database, such as migrations (scripts to create or modify database schema) and seed data (predefined data to populate the database for testing or initialization). infrastructure: Implements the data access layer, providing an abstraction over data persistence mechanisms like databases or external services. domain: Contains the business logic layer, responsible for implementing use cases and coordinating interactions between different components. utils: Contains utility functions and shared code that can be used throughout the application. tests.ts: Contains all the test-related files, including unit tests, integration tests, and any test utilities or fixtures. main.ts: The entry point of the application, responsible for bootstrapping and setting up the application. It initializes dependencies, middleware, and starts the server. server.ts: Handles web server setup and initialization, such as configuring middleware, defining routes, and starting the server.
The easiest way to deploy your node.js app is to use the AWS EC2
The structure contains docker compose for production and developemnt
- [Docker] (https://docs.docker.com/compose/gettingstarted/) - learn to run docker compose for containerized application.
Check out our Front End implementation.
This project is licensed under the MIT License. Feel free to use and modify the code as per your needs.