Giter VIP home page Giter VIP logo

parelpracht-server's Introduction


ParelPracht

ParelPracht is the successor of Goudglans, the custom Customer Relation Management system of Study Association GEWIS. This new system is built during the second lockdown of the corona pandemic. Its main goal is to automate tedious tasks and to keep a clear and concise overview of the current collaborations. This is achieved by creating nice structured insights tables and graphs and automating the generation of contracts, proposals and invoices.

This is the back-end of ParelPracht. The front-end can be found here.

Installation

  1. Clone the repository.
  2. Run npm install.
  3. Copy .env.example to .env and fill / replace the keys with their corresponding values. Note that the email-keys are important to be able to install the application (see step 5).
  4. Run npm run dev. This runs the client in development mode. Node will bind to port 3001. You can find the API documentation at http://localhost:3001/api/swagger-ui/.
  5. Make a POST-request to /v1/setup with your credentials. The required payload can be found in the Swagger documentation. This request will create a local administrator account with the given credentials. You will receive an email (on the given address via the given mail server at step 3) to set your password.
  6. In the VAT table, add the desired VAT categories and percentages.

You can also build the application with npm run build. This puts a production build in the ./build directory.

Deployment

  1. Clone the repository in a folder called parelpracht-client and clone the backend repository in a folder called parelpracht-server. Make sure that both folders are in the same parent folder.
  2. Change the image locations to the correct locations in docker-compose.yml (for both the frontend and backend).
  3. Fill in the correct (environment) variables in docker-compose.yml.
  4. Run docker-compose in ./parelpracht-client.

Copyright

Copyright © 2022 The 39th board of GEWIS - Some rights reserved. Created by Roy Kakkenberg, Koen de Nooij, Jealy van den Aker, Max Opperman, Wouter van der Heijden en Irne Verwijst. You can use our software freely within the limits of our license. However, we worked very hard on this project and invested a lot of time in it, so we ask you to leave our copyright mark in place when modifying our software. Of course, you are free to add your own.

License

GNU AGPLv3

parelpracht-server's People

Contributors

gewoonsandor avatar gijsdeman avatar irne avatar jealyvda avatar kdnooij avatar maikocheng avatar maxopperman avatar tomudding avatar woutderuiter avatar wvdh99 avatar yoronex avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

maikocheng

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.