Changes for v2 - Githubissues

danielfsousa / express-rest-boilerplate

⌛️ Express starter for building RESTful APIs

MIT License

2.34k stars 620 forks source link

Changes for v2 #334

Open danielfsousa opened 3 years ago

danielfsousa commented 3 years ago

I am planning on doing a big refactoring on this repo, since the last update was 3 years ago.

Rename express-rest-es2017-boilerplate to express-rest-boilerplate
Use postgres as database (Postgres is a more reliable database and better suited for general purpose use)
Use Objection or Sequelize as ORM
Rafactor RBAC middleware
Use npm instead of yarn
Change folder structure
Replace apidoc with OpenAPI spec
Use pino for logging
Create a tutorial for deploying to kubernetes or a serverless platform
Remove semicolons =D
Remove Bluebird
Refactor unit and integration tests
Replace mocha, chai, sinon and nyc with jest
Add prettier
Update eslint-config
Update node to 12+
Update dependencies
Improve README
Remove unnecessary dependencies
Simple type checking in vscode without typescript (I will probably create another boilerplate for typescript + fastify)

rayWille commented 3 years ago

Hey Daniel Thats great to see that you are updating this repo I have learned a lot of things from this repo and have used in many projects Thanks for sharing this repo

danielfsousa commented 3 years ago

Hey Daniel Thats great to see that you are updating this repo I have learned a lot of things from this repo and have used in many projects Thanks for sharing this repo

Hey @rayWille, thanks for the feedback!

It was a great experience creating this repo, I've learned a lot from it and I got my first programming job because of it.

I'm so glad to know that it was also useful for you and others.

Usama-Tahir commented 3 years ago

Hi @danielfsousa, first of all, congrats on such a wonderful project. We are 2,3 people planning to use this repository for one of our projects. We want to use MySQL instead of MongoDB, Sequalize, and Swagger. As you are going to update this repository to V2, we can help you with that. If you want to provide some guidelines or suggestions about the code structure or folder structure, you can and we will open a PR incorporating those changes. You can review the PR and merge it if fulfills all checks. Thanks

danielfsousa commented 3 years ago

@Usama-Tahir Cool! Thank you for your interest in this project. I'm busy this week, but I will create the issues with a detailed description later this month.

jonassunandar commented 3 years ago

Hi Daniel I learnt a lot by looking at this repo. Thank you so much. I am looking forward to seeing V2 of the repo.

alanbosco commented 3 years ago

Maybe can we get a option to choose mongo or postgress? make a cli? ><

mfachmirizal commented 3 years ago

waiting forward to this update ~

danielfsousa commented 3 years ago

Maybe can we get a option to choose mongo or postgress? make a cli? ><

We could make it simpler and have both postgres and mongo repositories, since javascript doesn't have interfaces we could use duck typing and choose the repository via an environment variable.

Having options to choose from a CLI would be great too. I've created a CLI to bootstrap this project: https://github.com/danielfsousa/npm-templates, we can implement a way of bootstrapping the template based on the variables you choose.