Skip to content

Latest commit

 

History

History
101 lines (73 loc) · 1.91 KB

README.md

File metadata and controls

101 lines (73 loc) · 1.91 KB
Raw

Work App

This project was setup using Vite to work with React for the frontend of the project.

Prerequisites

Before getting started, make sure you have the following installed on your machine:

  • Node.js
  • npm or yarn

Setup

  1. Clone the repository:
    git clone https://github.com/savvato-software/savvato-work-app-frontend-app.git
  1. Navigate to the project directory:
    cd work-app-frontend
  1. Install dependencies:
    npm install
    or

    yarn install

Running the Project

  • To run the project locally, use the following command:
    npm run dev
    or

    yarn dev
  • This will start the development server and will display the URL in the terminal.
    > work-app-frontend@0.0.0 dev
    > vite

    Re-optimizing dependencies because lockfile has changed

    VITE v5.4.2  ready in 378 ms

    ➜  Local:   http://localhost:5173/
    ➜  Network: use --host to expose
    ➜  press h + enter to show help

Project Structure

Here's a brief overview of the project structure:

├── public
│   ├── index.html
│   └── ...
├── src
│   ├── components
│   │   └── ...
│   ├── services
│   │   └── ...
│   ├── App.jsx
│   ├── App.css
│   ├── main.jsx
│   ├── index.css
│   └── ...
├── .gitignore
├── package.json
├── vite.config.js
└── ...

Contributing

If you'd like to contribute to the project, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature/bug fix.
  3. Make your changes and commit them.
  4. Push your changes to your forked repository.
  5. Open a pull request.

License

This project is licensed under the MIT License.