Preet-Sojitra / kalasangam-backend

Backend for KalaSangam

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Kalasangam (Backend)

This repository contains the backend code. To view the frontend code, head over to this repository. All the description and instructions are given there.

Live Demo:

The project is not deployed yet. I will deploy it soon or either I will provide a live demo of the project on youtube soon.

Team Members:

Version 1.0 of this project was developed by the following team members:

  • Kunal Sahoo
  • Kishan Pipariya
  • Preet Sojitra
  • Dharmi Patel
  • Dev Parikh
  • Saurav Navdhare
  • Rashida Kadiwala
  • Abhinav Sharma

Usage:

To use Kalasangam, you need to run it on your local machine only as of now. To do so, follow these steps:

You need to clone both the frontend and backend repositories to your local machine separately and start the servers for both of them separately.

  1. Clone this repository to your local machine using following command:
git clone https://github.com/Preet-Sojitra/kalasangam-backend
  1. Change the working directory to the backend repository's root directory and then change the working directory to node_backend directory using the following commands:
cd kalasangam-backend && cd node_backend
  1. Start the docker container using the following command:
docker-compose up
  1. Now, open a new terminal and run the following command to start the server:
npm run dev
  1. Open new terminal tab and seed the database using the following command:

But before running the following command, make sure that you have added Cloudinary credentials in the .env file. You can get the credentials by signing up on Cloudinary. It is most crucial part of the project as it is used to store the images.

chmod +x seed.sh && ./seed.sh

If file not found error occurs, then make sure you are in the root directory of the backend repository and then run the above command.

Please note that the above command is for Linux and Mac users only. For Windows users, you need to run the following command in the git terminal:

sh seed.sh

NOTE: You need to have Node.js and docker installed on your machine to run the above commands.

Now, head over to the frontend repository and clone it (if you haven't already).

About

Backend for KalaSangam


Languages

Language:JavaScript 97.6%Language:Shell 2.4%