MakerRepo App

The MakerRepo App is a PWA Application to use MakerRepo easily on mobile!
· Report Bug · Request Feature

(back to top)

Built With

• React.js
• TypeScript
• Bootstrap
• MUI
• Axios
• React Hot Toast

(back to top)

Getting Started

Prerequisites

• yarn

  npm install --global yarn

(back to top)

Dev Installation

To install the React App to contribute to new changes:

1. Clone the repo

   git clone https://github.com/uOttawa-Makerspace/makerepo-react-app

2. Enable corepack and install NPM packages

   corepack enable
   yarn install

3. Launch Dev Version of the MakerRepo Rails Server (See MakerRepo Github Repo)

4. Launch App on localhost:3001

   yarn start

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
3. Make sure Prettier & ESLint are passing
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

For more information, please see Documentation.md.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Author

• Arthur Fétiveau & MakerRepo App Contributors
• Github: UOttawa Makerspace
• Email: uottawa.makerepo@gmail.com

(back to top)