Skip to content

vudiep411/QuickVids-App

Repository files navigation


QuickVids

A social media platform for people to post videos, follows, like and comment using next.js for front-end, node.js for back-end, and sanity for database


Author

Vu Diep - [email protected]
Frank Salgado Gonzalez - [email protected]

Overview




Visit the fully deployed project

(back to top)

Built With

  • Next
  • Sanity
  • Node.js

(back to top)

App Architect

Database Design

Deployment

This application is deployed on Vercel

Future Scaling

If scaling is required, I would migrate the database (since sanity service is expensive) and create a load balancer.

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

npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/vudiep411/QuickVids-App.git
  2. Install NPM packages

    npm install
  3. Run the React Project

    npm run dev
  4. Install Sanity

    cd ./quickvids-backend
    npm install -g @sanity/cli
  5. Set up Sanity on web browser visit Sanity to complete the set up and get the secret token.

  6. Get google secret to activate sign-in with google library

  7. Create a .env file and place your sanity secret and google secret inside. See .env.example for reference.


Note:

⚠ Sign up to get Sanity secret token and place it in a .env file after to start with sanity follow instructions and install all packages needed
⚠ If you are planning to create more evironment variables, make sure to register them in next.config.json file

⚠ The client will be started at https://127.0.0.1:3000/
⚠ Sanity development server will be started at https://127.0.0.1:3333/

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: [https://github.com/vudiep411/QuickVids-App]

(back to top)

About

A social media web app like tik-tok

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published