https://github.com/digen21/postgraphile-boilerplate

Postgraphile Project Setup Boilerplate code
https://github.com/digen21/postgraphile-boilerplate

boilerplate expressjs nodejs postgraphile postgresql typescript

Last synced: 3 days ago
JSON representation

Postgraphile Project Setup Boilerplate code

• Host: GitHub
• URL: https://github.com/digen21/postgraphile-boilerplate
• Owner: digen21
• License: mit
• Created: 2024-09-29T07:51:00.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-09-29T08:26:05.000Z (3 months ago)
• Last Synced: 2024-12-24T11:54:13.699Z (15 days ago)
• Topics: boilerplate, expressjs, nodejs, postgraphile, postgresql, typescript
• Language: PLpgSQL
• Homepage:
• Size: 56.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**
Project Setup Guide 🚀
**


Follow these steps to set up the project on your local environment:

1. 
Setup Environment Variables 🌐


- copy the .env.example and make new .env.

  - add the required values in env file.

💡 **Tip: Check the .env.example for guidance on the format of the values.**









2.  
Install Dependencies 📦


    - Open your terminal in the project directory and run the following command to install all the required packages:

             yarn




⏳ Note: This might take a few minutes depending on your internet speed. Make sure all dependencies are installed before proceeding.









3.  
Database Setup 🗃️ 


    - Step 1: To set up the database, run the following command:

            yarn setup:db

    


    - Step 2: You will be prompted to drop and create a new database. Type yes to allow the system to proceed.

      - 🚨 Warning: Dropping the database will delete any existing data, so make sure you're okay with that before proceeding.









4. 
Explore Migrations 📜


   - After setting up the database, check out the migrations folder. This folder contains all the database migration files.

   - 🔍 Note: Migrations ensure that the database structure is up to date with the project. No need to modify anything unless you're making schema changes.









5.  
Start the Project 🏁


    - Finally, to run the project in development mode, use the command:

    


        yarn dev




🚀 Pro Tip: Once the project is running, visit http://localhost:port in your browser to see it in action!









You're all set! 🎉

If you run into any issues, feel free to check the logs for more details or contact the project maintainers.