content manager for ubccsss.org

Create posts for ubccsss.org using the GitHub REST API

Installation

$ git clone git@github.com:ubccsss/content-manager.git
$ cd content-manager
$ yarn install

Environment Variables

• REACT_APP_TOKEN - GitHub personal access token generated from using csssbot's account

Download the token from Netlify and store it in a file called .env in the root directory of the project. Like:

REACT_APP_TOKEN="QWERTY123"

Usage

$ yarn start # runs the app in the development mode a http://localhost:3000
$ yarn build # builds the app for production to the `build` folder

Contributing

Dependencies

• Netlify is used to deploy the app
• React is used to build the app
• TypeScript is used to type-check the app
• react-bootstrap is used to style the app
• Yup and Formik are used for form validation
• react-syntax-highlighter is used for syntax highlighting in the "Markdown" preview
• react-markdown is used for rendering markdown in the "Output" preview
• GitHub API is used to create a pull request using "@octokit/rest

Folder Structure

• src - contains all the source code for the app
  • api - contains all external api calls
  • components - contains all the components used in the app
  • constants - contains all the constants used in the app
  • contexts - contains all the contexts used in the app
  • reducers - contains all the reducers used in the app
  • utils - contains all the utility functions used in the app
  • App.tsx - the main app component
  • index.tsx - the entry point of the app