Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.35 KB

README.md

File metadata and controls

76 lines (51 loc) · 2.35 KB
Raw

Hours Frontend

The frontend for Hours — a real-time office hour management system used at Brown University.

Tech Stack 🥞

  • ⚛️ Next.js - a developer-friendly React framework for building web apps.
  • 🎨 Material UI - an extensive and themeable React component library.
  • 🧪 Jest - a Javascript unit testing library.
  • 🔬 React Testing Library - a lightweight utility library for unit testing React components.

Getting Started 🤓

Installation

Ensure you have the latest version of Node.js installed.

First, clone the repository:

git clone https://github.com/nthnluu/no-bs-react

Then, install the required dependencies:

cd no-bs-react
yarn install

Finally, run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

Create a new component

If you browse the src/components directory, you'll notice how each component has its own directory containing a number of files:

  • SampleComponent (SampleComponent obviously represents some arbitrary component)
    • SampleComponent.tsx - the React component code.
    • SampleComponent.test.tsx - the unit tests for the component.
    • index.tsx - a file that marks the component as the default export for the directory (you won't need to modify this file).

Of course, manually creating all these files is a lot of tedious work. Therefore, you're provided with a simple command line tool that can generate all of these files for you:

yarn add-component SampleComponent

This will generate a new component directory into src/components. You can move it into any directory within src/components as you see fit.

🛠 Contributing

Want to help make Hours even better? Awesome! Get started by reading our contributor guide.

License

This project is licensed under the terms of the MIT license.