Skip to content

NimayDesai/PeelDB

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

For FBLA 2023-2024 NLC (Individual)

By Nimay Desai

ACCESS THE WEBISTE NOW (https://peeldb.me)

The presentation for this project can be downloaded at this link

About the project

This website aims to provides a place for schools to add all their business and community partners for other people to access. The website allows the user to search through the list, and schools can add their own partners for other schools to see.

Right now, the website lists 25 initial partners that the school uses with Contact Info, Type of Organzaiation and Name of the Organizaiton

Technologies Used

Technology What it is used for
Next JS(https://nextjs.org/) An advanced React Framwork great for Serve Side Rendering
NodeJS (https://nodejs.org/en/guides) An open source runtime for javascript code on the server
GraphQL (https://graphql.org/) A query language for your API that connects your backend to your frontend
TypeScript (https://www.typescriptlang.org/) A high level program language based on Javascript, but with types
Apollo-GraphQL(https://www.apollographql.com/docs/react/) A management client for Javascript to mange GraphQL Data
Type-graphql (https://typeorm.io/) A modern framework for GraphqlAPI in Nodejs/Typesript
Postgres (https://www.postgresql.org/) An Open Soure Relational Database using SQL Syntax

How to Run Locally

$ git clone https://github.com/NimayDesai/SchoolOrganizationDB.git .

Configure Env

You can use the .env.example on the backend folder for your setup

Make sure you have PostgresSQL and Redis installed and running, as they are nescessary for the application to run

Create a database with PostgresSQL

Start backend

$ cd backend
$ yarn build
$ yarn start

Start Frontend

$ cd frontend
$ yarn build
$ yarn start