Project Showcase Server

Backend for Project Showcase (a platform for people to showcase their projects and build a project-centric profile)

Client Repo:-

https://github.com/vighnesh192/project-showcase-client

⚙️ Tech Stack

• Express.js
• PostgreSQL
• Objection.js
• Knex.js

🔨 Setup and Run

Setup local repo

Let's setup the server on your local machine.

0. Prerequisites

• Make sure you have Node.js installed on your machine.

1. Fork repo

Fork this repo to your GitHub account

2. Clone repo

Clone the forked repo to your local machine

git clone https://github.com/<YOUR-GITHUB-USERNAME>/project_showcase_server.git

Navigate to project directory

cd project_showcase_server

3. Install Dependencies

npm install

4. 📡 Setup remote

0. You will have to set up remote repositories for getting latest changes from original repository
1. Specify a new remote upstream repository that will be synced with the fork using follwoing command :

$ git remote add upstream https://github.com/vighnesh192/project_showcase_server.git

2. Verify the new upstream repository you've specified for your fork using git remote -v

origin  https://github.com/<your-user-name>/project_showcase_server.git (fetch)
origin  https://github.com/<your-user-name>/project_showcase_server.git (push)
upstream        https://github.com/vighnesh192/project_showcase_server.git (fetch)
upstream        https://github.com/vighnesh192/project_showcase_server.git (push)

5. 📌 Setting up .env file :

1. Create a new file .env in the root directory.
2. Copy all the default content from the .env.example file to the .env file.
3. You need to edit this .env file to provide your own credentials.

6. 📡 Setup database

• Make sure you have PostgreSQL installed on your machine.
• Run Migrations:-

  npm run migrate

Your application setup is successfully completed!

7. Running the app

npm start

✨ Contributors