Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.58 KB

README.md

File metadata and controls

46 lines (34 loc) · 1.58 KB
Raw

📚 Booked 📚

A place for people to create and manage their book clubs with ease

 

🔎 Table of Contents

🗝 Requirements

  • Postgres database instance
  • A Node.js development environment

📍 Development Enviroment Setup

  1. Fork this repo
  • click on the Fork button on the top right of the page
  • click on your handle to fork to your repo
  1. Clone this repository
  • enter the following line into your command line and insert your copied url instead of the quoted text:
git clone 'copied url'

  1. Install your npm dependencies: run npm install in your terminal.

  2. Copy template.env and create a .env file in the project root.

  • Specify the Postgres database connection URI as DB_URI.
  • Secret key for auth as SECRET_KEY.
  1. Start your node server and compile the application, run the following: npm run dev.

⌨️ Developers