Skip to content

React + TypeScript frontend using Ant.D component library and Redux for state management.

Notifications You must be signed in to change notification settings

Code-4-Community/frontend-scaffold

Repository files navigation

Code4Community Frontend Scaffold

This is the React.js frontend template for all Code4Community projects.

Build Status

Coverage Status

Installation 🔧

Use the package manager npm to install all the dependencies for our frontend.

npm install

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.
You will also see any lint errors in the console.

npm run check

Runs all 4 lint, type check, and test commands below, REQUIRED BEFORE MERGE.

npm run lint-fix

To lint and fix your files (required before merge).

npm run prettier-fix

To lint and fix your files (required before merge).

npm run type-check

Type checks your code (required before merge).

npm run test

Runs all unit tests (required before merge).

Code Walkthrough 💻

Inside the source folder, you'll find components, containers (pages), and utilities.

Each page has its own container, and each container is comprised of components.

App.tsx is responsible for rendering each container as its own route.

We use styled-components as our CSS-in-JS solution.

Contributing 🤝

Pull requests from any C4C member are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

About

React + TypeScript frontend using Ant.D component library and Redux for state management.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages