Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 1.58 KB

README.md

File metadata and controls

70 lines (47 loc) · 1.58 KB

ProjectHunt API ✨ 🌻 🌱

Version License: MIT

Setup Locally

  1. Duplicate and rename .env.example to .env and provide all environment var

  2. Provide right DB username,password,schema

Running the server

Without Docker

npm i
npm run watch
  • Open other terminal window and run dev server
npm run start:dev

With Docker

docker-compose up --build

If you get DB does not exists, simply run this:

sh scripts/sh/initdb.sh

Scripts

  1. seed - DB seed script, will insert dummy data
  2. watch - Watcher, for changes in TS files
  3. clean - Removes dist folder
  4. build - Compiles TS files, and spits JS version
  5. start - Start the server in prod mode
  6. start:dev - Start the server in dev mode
  7. lint - Lint the TS files with eslint

HTTPS Support

You can run this api over https now with the help of Caddy reverse proxy

Steps to enable HTTPS:

  1. Download and setup Caddy
  2. Open a new terminal and run caddy run Caddyfile in the root of project
  3. Enjoy API over HTTPS now 👍

In future will move Caddy to Docker, so we dont need to install it seperately

Contributions are welcome ⚡

Drop a pull request, and we will review and bring it to master

Show your support

Give a ⭐️ if this project helped you!