0.0.1 โข Published 12 months ago
@tardis-digital/art-con-room v0.0.1
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 ๐
- Docker ๐ณ (โ )
- DIY ๐ค (โ )
- DB of your own choice โ
- Postgres ๐ (โ )
- MySQL ๐ฌ (โ )
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!
0.0.1
12 months ago