Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/surajmgr/konnected_learn_together
College project of DBMS
https://github.com/surajmgr/konnected_learn_together
elephantsql nodejs pgsql react render
Last synced: about 7 hours ago
JSON representation
College project of DBMS
- Host: GitHub
- URL: https://github.com/surajmgr/konnected_learn_together
- Owner: surajmgr
- Created: 2023-05-14T09:59:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-09T04:09:28.000Z (9 months ago)
- Last Synced: 2024-09-27T18:21:44.782Z (about 7 hours ago)
- Topics: elephantsql, nodejs, pgsql, react, render
- Language: JavaScript
- Homepage: https://konnected-urn3.onrender.com/
- Size: 29 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Konnected
Konnected-proj is the main source folder inhabiting both the front-end and back-end. I'll describe about the functions of all those here. Let's first set up the project.
### Demo
Visit http://bit.ly/konnectEd for demo. If there are some errors, then it might be because the server has shut down. So, you could just visit https://codesandbox.io/p/sandbox/fancy-dawn-b17xoj and restart the server. Then, you will be good to go.
For visit purpose only https://konnected-urn3.onrender.com/ | Redirect from url won't work. You'll have to link from within the page.
### Set Up
For the first time, open two terminal in VS Code. Only one will also be sufficient, but it will be better to have two terminal in split view for client and server. Then, follow the below steps to install dependencies and start the web:
*Note: You must have installed [Node] and [npm] (It's included within [Node] package installer. No need to download separately)
To check if node & npm is installed, run the command:
**Node --version**
**npm --version**
If installed correctly, you'll see the version number.*
[Node]:
[npm]:
**First Terminal (Client - React)**
-- To install all the libraries used in the project, that is mentioned in the package.json file.
```sh
cd client
npm i
```
-- To start the react app (Port is 3000) [For every Start]
```sh
npm start
```
**Second Terminal (Server - Node)**
-- To install all the libraries used in the project, that is mentioned in the package.json file.
```sh
cd server
npm i
```
-- To start the server (Port is 5000) [For every Start]
```sh
nodemon index
```
*This will use nodemon library to auto restart the server on every change or save.*
**Database - Postgresql**
-- Install [Postgresql] in the system
-- Run Postgresql DB
-- Open data.sql file in the utils folder of server and run the queries given (This is for the first time only)
[Postgreqls]:
### Folder Structure
```
konnected-proj
└─── client
│ └─── public
│ │ │ index.html
│ └─── src
│ │ └─── components
│ │ │ └─── auths
│ │ │ │ │ login.jsx
│ │ │ │ │ register.jsx
│ │ │ └─── home
│ │ │ │ │ home.jsx
│ │ │ └─── utils
│ │ │ │ │ activateAccount.jsx
│ │ │ │ │ authContext.js
│ │ │ │ │ navbar.jsx
│ │ │ │ │ resetPassword.jsx
│ │ │ App.js
│ │ │ index.css
│ │ │ index.js
│ │ packagae-lock.json
│ │ package.json
│ │ README.md
│ │ tailwind.config.js
│ │
└─── server
│ └─── controllers
│ │ │ authController.js
│ │ │ btController.js
│ │ │ noteController.js
│ │ │ userController.js
│ └─── routes
│ │ │ authRoute.js
│ │ │ btRoute.js
│ │ │ noteRoute.js
│ │ │ userRoute.js
│ └─── utils
│ │ │ data.sql
│ │ │ db.js
│ │ │ queryDB.sql
│ │ index.js
│ │ packagae-lock.json
│ │ package.json
│ .gitignore
```