Say hello to campus-wide engagement with Faraday. Explore the Faraday app. Discover students to engage, learn and connect with at https://app.faraday.africa.
The Figma design for this project can be found here.
This is a React.js project bootstrapped with create-react-app.
In this project, the file architecture used is known as Architecture by Feature
, the react app is structured around specific features/ user stories. Here's a good resource for File architecture for React applications if you are unfamiliar:
Other helpful resources:
First, install the dependencies:
npm install
# or
yarn
Then, run the development server:
npm run start
# or
yarn start
Open http://localhost:3000 with your browser to see the app start on your computer.
You can start editing by modifying the JS files
. The page on the browser auto-updates as you save the file.
Pre-requisites:
- Create an account on the Development/Staging environment
- Join the Contributor Program so we can add you to the team of contributors in the Faraday GitHub organization.
Next;
- Read our Code of Conduct
- Read our General Guide to Contributing
- Get started Contributing, we can't wait to see what you have for us.
Got Questions or something to share that isn't an issue? Start a discussion.