Skip to content

learnable-2022/LMS-YA-6-FE

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LMS-YA-6-FE

Educate App Readme

This Readme file provides an overview and instructions for setting up and running a ReactJS app. It contains information on the project structure, dependencies, and available scripts to facilitate development and deployment.

Table of Contents

Project Overview

This ReactJS app is a web application built using the React library for building user interfaces.

Installation

To set up the project locally, follow these steps:

  1. Clone the repository:
  2. Navigate to the project directory:
  3. Install the dependencies:

    npm install

Usage

To run the app locally, use the following command:

npm start

Open https://localhost:3000 in your web browser to view the app.

Available Scripts

In the project directory, you can run the following scripts:

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

Folder Structure

The project structure is organized as follows: your-project/ README.md node_modules/ package.json public/ index.html favicon.ico src/ components/ pages/ App.js index.js

Dependencies

The app relies on the following dependencies:

"@react-oauth/google": "^0.11.0", "@testing-library/jest-dom": "^5.16.5", "@testing-library/react": "^13.4.0", "@testing-library/user-event": "^13.5.0", "axios": "^1.4.0", "crypto-js": "^4.1.1", "react": "^18.2.0", "react-dom": "^18.2.0", "react-icons": "^4.8.0", "react-player": "^2.12.0", "react-quill": "^2.0.0", "react-router-dom": "^6.11.2", "react-scripts": "5.0.1", "web-vitals": "^2.1.4"

Make sure to check the package.json file for the complete list of dependencies.

Contributing

Contributions are welcome! If you want to contribute to this project, follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/your-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature/your-feature
  5. Submit a pull request.

License

This project is licensed under the MIT License.