V-Updates Project

This project is a fanmade site for getting the latest relevant tweets from popular Virtual Youtubers.

Setup

To set up and run the project you will need to have node (at least version 12) and yarn installed.

Status

See Issue #47

Design

Refer to Issue #2.

Frontend

The frontend uses reactjs

Use the public folder for images and assets.

For styling there is scss with css modules, so do not ever put any css inline unless absolutely required.

Also for styling there is the variables.scss which is to be used for global variables like colors and mixins. The globals.scss is mainly used for standardization and should rarely be touched at all.

Backend

The backend uses Express.js as server for hosting a REST API, which is all set up inside the src/index.js. Backend also uses several other library:

Mongoose as ODM for Mongo DB
cors as enabler for CORS requests

Backend Folder Structure

backend
├───src
    ├───controllers
    ├───middlewares
    ├───models
    │   └───schemas
    ├───services
├───index.js
├───.env.example
├───package.json
└───package-lock.json

Available Scripts

In the project directory, you can run:

`npm start`

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

`npm startFrontend`

Runs the frontend in development mode.
Test data isn't currently available for viewing. Open http://localhost:3000 to view it in the browser.

`npm startBackend`

Runs the backend in development mode.
Open Postman/VS Code Rest Client/ or some other rest api tool to make http requests.

License

SVGs used were from fontawesome. Link to the license

MIT

H-isaac23 / V-Updates