smunoz1988 / vecs-school-frontend

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Link to Live Demo
  • 🚀 Link to VECS School API
  • 🚀 Link to VECS School Kanban Board
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Team
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements

• 📝 License

📚💻🌐 VECS SCHOOL FRONTEND

Welcome to the frontend repository of VECS School's course booking platform. This repository hosts the user interface components and interactions that enable users to effortlessly browse courses, select preferred cities and dates, and make course bookings with price. The frontend is designed to seamlessly communicate with the backend API, providing a smooth and intuitive booking experience..

🛠 Built With

Tech Stack

Client

• Library: React
• State management: Redux
• Styling: CSS

Backend

• API Integration: VECS School API

Utils

• Testing Framework: Jest
• Package Manager: Node Package Manager(npm)

Key Features

• Course Exploration: Users can explore available courses, view details, and learn about instructors and course content.

• Booking Flow: A user-friendly booking process guides users through selecting courses and dates, providing clear instructions and feedback.

• Responsive Design: The frontend is optimized for various devices, ensuring a consistent experience across desktops, tablets, and smartphones.

• Visual Feedback: Users receive visual cues for successful bookings, errors, and important actions, enhancing user confidence.

(back to top)

🚀 Live Demo

• Check out VECS SCHOOL app here.

(back to top)

🚀 Link to API

• Check out VECS SCHOOL API app here.

(back to top)

🚀 Link to Kanban Board

• Check out our kanban board here.

• Check out our initial kanban board Here

(back to top)

💻 Getting Started

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

Prerequisites

Before you begin, make sure you have the following prerequisites:

• A modern web browser such as Google Chrome or Mozilla Firefox..
• An internet connection.
• The latest version of VECS School project.

Setup

Clone or download the VECS School repository to your local machine.

  git clone https://github.com/smunoz1988/vecs-school-frontend.git

Open your terminal and navigate to the cloned project directory.

  cd vecs-school-frontend

Install

Install the project dependencies by running the command:

npm install

Usage

Run the following command to build the project:

npm run build

Start the localhost server to run the application locally.

  npm run dev

Open your web browser and go to http://localhost:5173 and the application will be running.

🚀 Team members

• Final number of team members: 4. Details on Authors

👥 Authors

👤 Vanessa Oliveros Padron

• GitHub: @vvoo21
• Twitter: @vaneoliverosp
• LinkedIn: vaneoliverosp

👤 Santiago Munoz

• GitHub: @smunoz
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Christian Onoh

• GitHub: @christianonoh
• Twitter: @onohchristian
• LinkedIn: Christian Onoh

👤 Vitoesi Elijah

• GitHub: @Ellyboi
• Twitter: @elijahvitoesi
• LinkedIn: @Elijah

(back to top)

🔭 Future Features

• City and Date Filtering: Courses can be filtered based on city and available dates, ensuring users find courses that match their preferences.
• Feedback Mechanism: Users can provide feedback on courses they've attended, helping improve the overall course quality.

(back to top)

🤝 Contributing

We're committed to continuously improving VECS School. If you encounter any issues or have suggestions for improvement, please submit an issue.

(back to top)

⭐️ Show your support

If you like this project please give it a star ⭐️. Thanks for your support!

(back to top)

🙏 Acknowledgments

I would like to thank

• The VECS School contributors/team.
• Special thank to Murat Korkmaz for providing the design guidelines.

(back to top)

📝 License

This project is MIT licensed.

(back to top)