ashikka/motorq-client

Frontend repository for motorq task

motorq-client

Course registration and Timetable management system to make your student life easier!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

About The Project

Making a good timetalble while taking care of clashes is a mess! This application was made to take care of that automatically for you. You can build your timetable, check for clashes and even render a map showing the distance between all the classes! Now managing your timetable is so easy! You can find the demo video here

Built With

• react
• redux
• axios
• react-bootstrap
• react-router-dom
• react-dom

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/ashikka/motorq-client.git

2. Install NPM packages

npm install

3. Add the necessary environment variables to a .env file.

{
        echo '  REACT_APP_BACKEND_URL='
} >> .env

Usage

To run the project use:

npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

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

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push -u origin feature/AmazingFeature)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

License

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