simandebvu/find-a-tutor

Finding Education and Ideas - Made Easy

Find A Tutor

Find a Tutor

A React On Rails Based Project
Issues »

Report Bug · Request Feature

The project is based on a find your house app. But this is inspired with the current shift in the global scale- to finding a tutor. It has capability for users to create tutors, add to favourites and has been built with a test driven approach. Currently the user can:

1. Log in the app,authenticated by devise
2. The user is presented with a list of tutors they either created or created by other users.
3. When a user selects a tutor, detailed information about the tutor is presented and the possibility add the tutor to favourites
4. The user can access a list of favourite tutors

Table Of Contents

• Find A Tutor
  • Table Of Contents
  • Built With
  • Usage
  • Live Demo
  • Automated Test
  • Walkthrough Video
  • Authors
  • 🤝 Contributing
  • Show your support
  • Acknowledgments
  • 📝 License

Built With

• Node.js
• React
• Ruby On Rails
• ESLint
• Rubocop
• React-DOM
• React-Create-App
• npm
• CSS
• ES6

Usage

To have this app on your pc, you need to:

• download or clone this repo:

  • Clone with SSH:

    git@github.com:simandebvu/find-a-tutor.git
  

  • Clone with HTTPS

    https://github.com/simandebvu/find-a-tutor.git
  

• In the project directory, you can run:

  • $ npm install - installs all the dependencies required by the project

  • $ npm 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.

  • $ npm run 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!

Live Demo

Live Demo Link 👈

Automated Test

Open the terminal in the project's root directory and run:

$ bundle exec rspec

• the following output will be generated

Walkthrough Video

Live Video Link 👈

Authors

👤 Shingirayi Mandebvu

• Github: @simandebvu
• Twitter: @simandebvu
• Linkedin: linkedin

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse

📝 License

This project is MIT licensed.