CodeSupport Website Frontend

About

This repository contains the frontend for the CodeSupport Website. The project is written in JavaScript using the React user interface library.

Dependencies

Production

• React
• React DOM
• React Router DOM
• React Scripts
• React Helmet
• React Font Awesome
• Font Awesome SVG Core
• Free Brands SVG Icons
• Axios
• Query String

Development

• Jest DOM
• React Testing Library
• User Event
• Enzyme
• Enzyme Adapter for React 16
• Codacy Coverage

Setup

1. Navigate into the repository on your computer and run npm i
2. Start the React app with npm start
3. Navigate to http://localhost:3000 in your browser

Want an easier setup? Pull down our website development environment and quickly start working.

Structure

We're using Atomic Design to keep our folders organised. There are three main folders:

• Our tests live inside __tests__/
• Our components live inside components/
• Our services live inside services/
• Our styling lives inside css/

Please name files (which aren't components) with their type in, for example GitHubService or UserProfileServiceTest. This helps make the file names more readable in your editor.

Tests

We are using Jest with Enzyme for our tests. Any code that manipulates the state or fetches data from an API must be tested.

Commands

• To start the React app use npm start
• To test the React app use npm test
  • Use npm test -- --coverage to get a coverage report

Any Questions? Feel free to mention @LamboCreeper#6510 in the CodeSupport Discord.