starsheriff2 / expert-class-frontend

This app allows users to sign up for a class taught by experts and gurus. This is the front-end, a React app hosted in Netlify. The back-end is hosted in Railway.app.

Expert Class

This web app allows users to sign up to courses in different cities around the world taught by leading experts in every field.

Note: This web app uses cross-site cookies. You need to enable cross-site cookies in Safari and Chrome to be able open the app in your device.

About

Expert Class is a fully responsive web app that I built with a team of 4 members that uses a Ruby on Rails REST API to make CRUD operations. The repo for the back-end is here. We followed this concept design by Murat Korkmaz.

Some of the technical highlights implemented in this project:

• Private Routes
• Session Cookies for Authentication
• UseEffect hooks
• Swiper
• MSW for API mocking
• React Testing Library
• History for smart redirects
• Redux Toolkit
• Integration tests
• Styled Components
• Efficient global state management

Features:

• Username sign up and sign in
• Sign up for a class
• Create and delete classes

Live Demo

Deployed to Netlify: Live Demo

Video Presentation

Watch a quick demo and walk-through of this project:

Expert Class - 13 January 2022 - Watch Video

Built With

• HTML, CSS, JavaScript
• React
• React Router
• Redux Toolkit
• Axios
• Sass
• Jest
• MSW
• React Testing Library
• Swiper

About the API

• This app consumes a Ruby on Rails API. Here's the link to the backend API.
• All documentation can be accessed here.

Project Management

This project's tasks are described in this kanban board.

Getting Started

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

Prerequisites

• A browser to open the main file
• Node.js
• NPM
• Yarn

Get files

1. Open your terminal or command prompt.
2. If you do not have git installed in your system, skip this step and go to step 3; otherwise, go to the directory where you want to copy the project files and clone it by copying this text into your command prompt/terminal: [email protected]:StarSheriff2/expert-class-frontend.git.
   Now go to the "Install Dependencies" section
3. Download the program files by clicking on the green button that says “Code” on the upper right side of the project frame.
4. You will see a dropdown menu. Click on “Download ZIP.”
5. Go to the directory where you downloaded the ZIP file and open it. Extract its contents to any directory you want in your system.

Install Dependencies

1. Go to the root directory of the project
2. In your command line, while in the root dir, type npm install. It will install all necessary dependencies in your project files
3. Now type yarn start or npm run start. It will load the project in your default browser.
   
   Note:
   This command will not stop on its own. If you change something in your project files, it will recompile and reload the page in your browser. To exit, hit "ctrl + c"

Development

Bundle project

• yarn build

Testing

To test, run

• yarn test

Linters

To run the linters included in this repository, go to the root directory of your repository and copy/paste the following commands into your terminal: (Note: Make sure you run npm install before you do this)

• for ESlint, npx eslint.
• for Stylelint, npx stylelint "**/*.{css,scss}"

All Available Scripts

In the project directory, you can run:

yarn 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 warnings in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn 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!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point, you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However, we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Usage

• Sign in / sign up
• Add, remove, and view a class
• Register for a class
• View all your class reservations

Authors

👤 Arturo Alvarez

• Github: @StarSheriff2
• Twitter: @ArturoAlvarezV
• Linkedin: Arturo Alvarez

👤 Breno Xavier

• GitHub: @brenoxav
• LinkedIn: Breno Xavier

👤 Francis Uloko

• GitHub: @francisuloko
• Twitter: @francisuloko
• LinkedIn: Francis Uloko

👤 Mih Julius

• GitHub: @Mihndim2020
• Twitter: @mihndim
• LinkedIn: Mih Julius

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

🤝 Acknowledgements

Design:

• Original design idea by Murat Korkmaz
• Licenced under The Creative Commons license

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.