Skip to content

Boilerplate code for Koa APIs with the boring stuff done for you

License

Notifications You must be signed in to change notification settings

justanotherstarter/koa-hackathon-starter

Repository files navigation

koa-hackathon-starter

Koa boilerplate app which uses postgres as it's database and Sequelize as an ORM.

Setup

  1. Copy .env.example into .env and fill it out.
  2. Change the package name (and other details) in package.json.
  3. Setup the packages with npm install, make yourself a cup of tea this can take long.
  4. Create a database (with the same name in your .env) using your favourite DB admin tool.
  5. Run npm run createscripts, this will handle permissions for all the scripts in bin/.
  6. Run npm run createtables, this will create tables in your database from your models.
  7. Put your frontend in static/.
  8. You're done! Launch the app with npm run serve:dev and open it in your browser.

TODO

  • Dockerize - use docker-compose so that you can have different containers for db and app

About

Boilerplate code for Koa APIs with the boring stuff done for you

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published