diff --git a/README.MD b/README.MD index e69de29..8f8ccfe 100644 --- a/README.MD +++ b/README.MD @@ -0,0 +1,17 @@ +# Find Mates API + +A simple REST API written in Node.js and Express.js. + +## How to run + +Execute `npm run dev` command in the console. + +## How to build + +Execute `npm run build` in the console. + +## Other useful commands + +Execute `npm t` or `npm run test` to run unit tests. +Execute `npm run lint` to enable linting. +Execute `npm run seed` to run seeders.