Skip to content

README.md

Latest commit

 

History

History
59 lines (41 loc) · 1.43 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.43 KB

Matadorz Course Guide FrontEnd

This is the frontend application for the Matadorz Course Guide, built with React.

Features

  • Display course information.
  • Search for courses and teachers.
  • Responsive design.

Installation

  1. Clone the repository:

    git clone https://github.com/MB-KING/Matadorz-Course-Guide-FrontEnd.git
cd Matadorz-Course-Guide-FrontEnd

  2. Install dependencies:

    npm install

  3. Create a .env file in the root directory and add your environment variables based on .env-sample.

  4. Start the development server:

    npm start

Available Scripts

In the project directory, you can run:

  • npm start: Runs the app in the development mode.
  • npm test: Launches the test runner in the interactive watch mode.
  • npm run build: Builds the app for production to the build folder.

Project Structure

  • public/: Public assets and the HTML template.
  • src/: Source code for the React application.
    • components/: Reusable components.
    • pages/: Page components.
    • services/: API service calls.
    • styles/: CSS and styling files.

Contributing

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin feature/YourFeature).
  5. Create a new Pull Request.

License

This project is licensed under the MIT License.