Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/efraa/pokedex-api


https://github.com/efraa/pokedex-api

expressjs nodejs postgresql typeorm typescript

Last synced: 18 days ago
JSON representation

Awesome Lists containing this project

README 

        
# Pokedex API 🚀



The structure of this project aims to structure the code based on components. Instead of repeating the name of the component in a folder of controllers or domain, each component is composed of its own entity, routes, controller, services, repository, test, among other files.



Each component has its providers file to avoid contact with the other files from the outside. Anyone who requires a file of its component should request it from the *.providers.ts file.



This project follows the DDD architecture and simulates the behavior of microservices.



The dependencies are managed by a container (IoC) to have a low or no coupling.



### Followed best practices ❤️

***



1. 🔗 [NodeJS Best Practices](https://github.com/goldbergyoni/nodebestpractices)

2. 🔗 [DDD Architecture](https://en.wikipedia.org/wiki/Domain-driven_design)

3. 🔗 [Inversion of control (IoC)](https://en.wikipedia.org/wiki/Inversion_of_control)



### Main Technologies ⚙️

***



1. 🔗 [NodeJS >=12.6.0](https://nodejs.org/)

2. 🔗 [ExpressJS](https://expressjs.com/)

3. 🔗 [TypeScript](https://www.typescriptlang.org/)

4. 🔗 [TYPEORM](https://typeorm.io/#/)

5. 🔗 [PostgreSQL](https://www.postgresql.org/)

6. 🔗 [Jest](https://jestjs.io/)



### Getting Started 📌

***



__This API is consumed by the Pokedex hosted in the following repository:__ [Pokedex](https://github.com/Efraa/pokedex)



1. Clone

2. Move to --> `cd pokedex-api`

3. copy `.example.env` to `.env`

4. Run `npm install`

6. Be sure to create your Postgres database.



### Env variables 📌

***



* `PORT` : The port used by the application to expose itself. *Default* --> `2302`

* `PREFIX_ROUTES` : Prefix that routes use. *Default* --> `/api/v1`

* `DB_HOST` : Database address. *Default* --> `localhost`

* `POSTGRES_USER` : Database user.

* `POSTGRES_PASSWORD` Database pass.

* `POSTGRES_DB` : The database name used by the application.

* `TOKEN_EXPIRE` : When authentication tokens expire. *default* --> `72h`

* `SECRET` : Secret word to generate authentication tokens. *default* --> `secret-pokedex-api`

* `SMTP_EMAIL` : Your GMAIL email to send emails. *example* --> `[email protected]`

* `SMTP_PASSWORD` : Password of your GMAIL email.

* `AGENT_CLIENT_URI` : Base URL of your Frontend client. *default* --> `http://localhost:3000`



### Ready 📌

***



Run `npm run watch` ✔️



### NOTE 📢

***



The first registered user is assigned the ROLE = OWNER, this will have special permissions

in all its pokedex, according to the requirements.



* Update, Delete, Disable, List and view users.

* Update, Delete, Disable, List and view pokedex.

* If the OWNER deletes a user or pokedex, all data related to it is deleted.



### Password validation 📢



User passwords have a small layer of additional validation

to avoid the use of common or highly insecure passwords.



You can see this list of common passwords in



``` src/infrastructure/utils/commonPasswords.txt ```



You can add more passwords or delete from this file.



### Contribute 📌

***



To contribute to this repo you must consider the following:



1. 🔗 Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)

2. Consider the use of dependencies well.

3. Read about Node JS Best Practices.

4. Follow the architecture that takes the project.

5. 🔗 Use [Git Flow](https://danielkummer.github.io/git-flow-cheatsheet/)



## End 📌



If he came this far it is because we are ready. ✔️



You can consult the Documentation at this URL:



🌐 [Pokedex Docs](https://documenter.getpostman.com/view/7831505/SVtWvmoc?version=latest)