-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'CI/CD-workflow' of https://github.com/ELEF-TQ/Vivo_Energy…
… into CI/CD-workflow
- Loading branch information
Showing
10 changed files
with
112 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.vercel |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Vivo Energy | ||
|
||
## Overview | ||
|
||
Vivo Energy is a web application designed to streamline operations for fuel station management. It consists of two main components: | ||
|
||
- **Client (Frontend)**: Built with React and Vite, this component provides a user-friendly interface for customers and administrators to interact with the system. | ||
- **Server (Backend)**: Powered by NestJS, the server manages the business logic and interacts with the database to handle user requests and data management. | ||
|
||
## Features | ||
|
||
- **User Authentication**: Secure login and registration system for customers and administrators. | ||
- **Client Management**: Manage client profiles and track client activities. | ||
- **Fuel Station Management**: Administer fuel station operations, including fuel sales, inventory management, and staff management. | ||
- **Reporting and Analytics**: Generate reports and analyze data to gain insights into business performance. | ||
|
||
## Getting Started | ||
|
||
To get started with Vivo Energy, follow these steps: | ||
|
||
1. Clone this repository to your local machine. | ||
2. Navigate to the `client` directory and run `yarn install` to install dependencies. | ||
3. Navigate to the `server` directory and run `yarn install` to install server dependencies. | ||
4. Configure environment variables in the `.env` file located in the `server` directory. | ||
5. Start the client and server applications by running `yarn dev` in their respective directories. | ||
|
||
## Contributing | ||
|
||
We welcome contributions from the community to help improve Vivo Energy. If you'd like to contribute, please follow these guidelines: | ||
|
||
1. Fork the repository and create a new branch for your feature or bug fix. | ||
2. Make your changes and ensure they adhere to the project's coding style and guidelines. | ||
3. Write tests to cover your changes if applicable. | ||
4. Submit a pull request with a clear description of your changes and the problem they solve. | ||
|
||
## License | ||
|
||
This project is licensed under the [MIT License](LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters