SQL4U

Dynamic online and learning website providing tutorials on Database
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Start The Website
3. Roadmap
4. Contributing
5. Contact

About The Project

This is group 4's final project about building a dynamic online and learning website providing tutorials, projects on Database.

This website was originally hosted on AWS. However, due to too much money charged by AWS for hosting services, we had to shut down the server after the project was graded. See the report for more informatino about hosting ( Page 28-35).

Backend server is hosted on Render. Frontend server is hosted on Netlify

You can create account or use this to login:

username: cs160-1@gmail.com
password: password1

Project Report

Built With

• 
• 
• 
• 

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• MongoDB

  https://www.mongodb.com/docs/manual/installation/
  

• Node.JS

  https://nodejs.org/en/download/
  

Installation

1. Generate key on https://generate-random.org/api-key-generator?count=1&length=128&type=mixed-numbers&prefix=
2. Clone the repo

   git clone https://github.com/dongtandung2001/SQL4U.git

3. Install NPM packages
   • backend server

   cd backend
   npm i

   • frontend server

   cd frontend
   npm i

4. Import database

   mongorestore -d sql4u path_to_project/sql4u

(back to top)

Start the website

1. Database

   mongod

2. Backend server

• Enter your key in process.env

  export sql4u_jwtPrivateKey='Your generated key (constant)'

• Start server

  cd backend
  npm start

3. Frontend server

• Add proxy to package.json to resolve CORS ( don't need to do this when hosting)

  "proxy": "http://localhost:3900"

• Setting environment variables in env.development

  REACT_APP_API_URL=/api

• Start server

  cd frontend
  npm start

Roadmap

• Learning Hub
• Interview Question
• Q & A
• Recommended Project
• Content Management System

All features are recapped in the report. ( Page 50 - 64)

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Dung (Daniel) Dong - dongtandung2001@gmail.com

Project Link: https://github.com/dongtandung2001/SQL4U

(back to top)