Skip to content

Latest commit

 

History

History
167 lines (108 loc) · 4.95 KB

README.md

File metadata and controls

167 lines (108 loc) · 4.95 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Opportutoring Logo

Opportutoring Platform

The Opportutoring Platform is designed to help tutors collaborate.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

The project can be accessed through this link: https://opportutoring-platform.web.app/. We have currently only enabled sign-ins as we only want admins to be allowed to create a new user. To explore the platform, sign in with the details below: username: [email protected] password: 123456

As of 23/10/2020, the login page and logging in capabilities are finished. However, the home page, and resources page are still blank. The add lesson form has been created and does add the lesson into our database, which can be viewed through the firebase console. We have hard-corded several values for testing purposes currently, however, they will be changed after we have set some other aspects up.

Known Bugs

  • you can still see the login page for a split second once it refreshes and you are already logged in, before transferring you to the home page

Built With

Getting Started

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

Prerequisites

Installation

  1. Clone the repo
git clone https://github.com/fac20/tfb-bonf.git
  1. Install NPM packages
npm install
  1. Create a .env file

STOP READING HERE, IGNORE BELOW

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

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 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

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

Contact

Your Name - @twitter_handle - email

Project Link: https://github.com/fac20/tfb-bonf

Acknowledgements