Skip to content

Latest commit

 

History

History
148 lines (88 loc) · 7.14 KB

README.md

File metadata and controls

148 lines (88 loc) · 7.14 KB
Raw

project chat License: GPL v3 Open Source Love Maintenance PRs Welcome GitHub forks GitHub stars HTML CSS TypeScript React

About STEM Diverse TV Content Management System

Content Management System (CMS) for managing content of STEM Diverse TV backend. This repository is for frontend part for STEM Diverse TV backend, so we could manage add/remove and edit content of our platform apps.

At the moment all content is coming from Youtube, however we are planning to extend that with other sources in future.

About STEM Diverse TV Project

STEM Diverse TV is a project which gather and provide inspiring, motivating, informative, educational and supportive videos about diversity in STEM. This is the frontend of the project.

Technical Stack

  • React JS.

Setup and run

To setup the project locally follow the instructions:

Fork

Note: This is only needed if you want to contribute to the project.

If you want to contribute to the project you will have to create your own copy of the project on GitHub. You can do this by clicking the Fork button that can be found on the top right corner of the landing page of the repository.

Clone

Note: For this you need to install git on your machine. You can download the git tool from here.

  • If you have forked the project, run the following command -

    git clone https://github.com/YOUR_GITHUB_USER_NAME/stem-diverse-tv-cms

    where YOUR_GITHUB_USER_NAME is your GitHub handle.

  • If you haven't forked the project, run the following command -

    git clone https://github.com/anitab-org/stem-diverse-tv-cms

  • Now after you cloned the repository, get into the stem-diverse-tv-cms directory by -

    cd stem-diverse-tv-cms

Remote

Note: This is only needed if you want to contribute to the project.

When a repository is cloned, it has a default remote named origin that points to your fork on GitHub, not the original repository it was forked from. To keep track of the original repository, you should add another remote named upstream. For this project it can be done by running the following command -

git remote add upstream https://github.com/anitab-org/stem-diverse-tv-cms

You can check that the previous command worked by running git remote -v. You should see the following output:

$ git remote -v
origin  https://github.com/YOUR_GITHUB_USER_NAME/stem-diverse-tv-cms (fetch)
origin  https://github.com/YOUR_GITHUB_USER_NAME/stem-diverse-tv-cms (push)
upstream        https://github.com/anitab-org/stem-diverse-tv-cms (fetch)
upstream        https://github.com/anitab-org/stem-diverse-tv-cms (push)

Run app

Download the latest stable version of NodeJs here and install it.

For yarn users

Install yarn. Run node --version and yarn --version to verify successful installation.

To get the frontend running locally:

  • Run yarn or npm i to install all required dependencies

  • Setup the env file in the root directory of the project & copy the template from the sample env file

    • If you are running it locally & want your credentials to be stored in your project that you made on firebase you need to set REACT_APP_ENVIRONMENT_CONFIG=local

    • If you are running it & want your credentials to be stored on the hosted version of this project i.e, https://stem-diverse-tv.herokuapp.com/ ,you need to set REACT_APP_ENVIRONMENT_CONFIG=prod

  • Run yarn start or npm run start to start the local server

Contributing

Lint & Format

This repository using Eslint and Prettier for linting code and formatting source code.

To Run ESlint

You may use npm or yarn for this -

npm run lint : Lint check.

npm run lint:fix : Lint check and also fixes errors.

To Format Files:

npm run format:check : Check if code already formatted.

npm run format : Format code.

This project is under active development

Please read our Contributing Guidelines, Code of Conduct and Reporting Guidelines thoroughly.

Contributors

Thanks goes to these people (emoji key):


Anna Bauza
💻 🚧 ⚠️ 📖 🎨

This project follows the all-contributors specification. Contributions of any kind welcome!

Branches

  • master: This contains the latest code. All the contributing PRs must be sent to this branch.
  • production: Merge to master will trigger deployment static github page and publish it on production branch.

Contact

If you have any questions or want to discuss something about this repo, feel free to reach out to our team on our Zulip channel #STEM-Diverse-TV. If you are a new contributor, head over to this project's stream on Zulip to see ongoing discussions.

License

The project is licensed under the GNU General Public License v3.0. Learn more about it in the LICENSE file.