Skip to content

marcyves/VRP-Resource-Planning

Repository files navigation

VRP

VRP Resource Planning

Project planification and budgeting

Issues GPL 3 LinkedIn


Logo

VRP

VRP started as a personal side projet in order to help me plan and budget my different projects. Gradually, this is evolving into an ERP System for freelancers and vacataires.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Planary

(back to top)

Built With

This section list any major frameworks/libraries used to bootstrap this project.

  • Laravel
  • Tailwind

(back to top)

Getting Started

These are the instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

If you want to run Planary you need to have a MySQL server available, npm and composer installed on your computer.

Installation

You need `composer`` to install the project and then follow the usual steps for a Laravel project.

  1. Clone the repo
    git clone https://github.com/marcyves/VRP.git
  2. Install Laravel modules
composer install
  1. Copy .env.example to .env Review Data Base parameters, you can go for SQLite or MySQL but in this case you need to set up and start a MySQL server.
  2. Set the application key
php artisan key:generate
  1. Create the Database
php artisan migrate
  1. Install NPM packages
    npm install
  2. Run Vite
npm run dev

(back to top)

(back to top)

Roadmap

  • Create Readme
  • Add "Roadmap" to the readme
  • Multi-language Support
    • French
    • Italian

See the open issues for a full list of proposed features (and known issues).

(back to top)

Very Short Documentation

User Statuses

  • 1 admin (for their company)
  • 2 éditeur
  • 3 rédacteur
  • 4 SuperAdmin (all companies)

Online demo

You can give a try to the project at http://vrp.xdm-consulting.fr/

email: [email protected] password: topsecret

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GPL 3 License. See LICENSE.txt for more information.

(back to top)

Contact

Marc Augier - @marcyves

Project Link: https://github.com/users/marcyves/projects/3

(back to top)

Acknowledgments

Resources I find helpful and would like to give credit to.

(back to top)

vous avez aimé ?

Pourquoi pas me remercier en m'offrant un café ?

Buy Me A Coffee

Réalisé par @marcyves

Notice

About

Project planification and budgeting

Resources

License

Stars

Watchers

Forks

Releases

No releases published