This is an example project, it can be used as a boilerplate to create a rest api with best practices and some ready-made features such as: WebToken Authentication (JWT), OpenAi API Integration, Redis cache, Admin CRUD with AdminJS etc.
The project is still under development and the next updates will focus on the following tasks:
- Improvement OpenAi integration
- Run project with docker
- Error middleware
- JWT token auth
- DDD
- Tests
Before you begin, make sure you've met the following requirements:
- You have installed the latest version of
<Typescript / NodeJS 18 / Docker>
.
To install follow these steps:
Install dependencies with yarn or npm:
yarn
or:
npm i
run the following command:
yarn docker:run && yarn dev
or:
npm run docker:run && npm run dev
this will upload a container in docker with postgresql, redis, zookeeper and kafka
To contribute to the project, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to original branch:
git push origin <project_name> / <location>
- Create the pull request.
Alternatively, see the GitHub documentation on how to create a pull request.
Thanks to the following people who contributed to this project:
Cleisson Barbosa |
This project is under license. See the LICENSE file for more details.