Skip to content

bristol-tech-fair/btf-frontend

Repository files navigation

Bristol Tech Fair - Frontend

This project was bootstrapped with Create React App.

Getting started

To run this project you will need Node.js and Yarn v1 installed.

  1. Install node - https://nodejs.org/en/

  2. Install Yarn v1 - https://classic.yarnpkg.com/en/docs/install/

Node handles our build tools, yarn is our package manager and used to run scripts.

Available Scripts

In the project directory, you can run:

yarn 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.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn storybook

Starts the design system which you will be able to open on [http://localhost:6006], from here you can view our component library and instructions on how to build and commit new components.

More about storybook here.

yarn component <component-name>

Our component generator script, replace <component-name> with the actual name of your component. This will take care of creating the correct files for you.

Any questions please start on discussion with the lead team.

About

The frontend application for the Bristol Tech Fair site.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published