Art-Con-Room
Generate a new Node.js based API project
Features
-
Ava for testing
🧪 -
TypeScript baked in
🙌 - Backend Framework of your choice
- ORM Support
- Deploy your apps
🏗 - DB of your own choice ⌗
-
Postgres
🐘 (✅ ) -
MySQL
🐬 (✅ )
-
Postgres
Usage
Generate a Personal Access Token with
read:packages
scope
# install dependencies, this step will only work if you're logged in
$ npx art-con-room backend-service
# serve with hot reload at localhost:3000
$ npm run start
# build for production
$ npm run build
Test
# Will run all tests
$ npm run test
Deployment
Deployment can be done using docker or do-it-yourself.
Note: If you're using docker, update the .env
file at the root of your repo before starting the containers
# Will build & start your containers
$ docker-compose up --build -d
Contributing
- Commits & PRs should now be allowed only if they follow a particular commit format, read more about it here
- Please contribute using Github Flow. Create a branch, add commits, and open a pull request
✨
Contributors Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!