From acba47fede8ba1f9952ad77eae7f9a4590ce3fa8 Mon Sep 17 00:00:00 2001 From: Alf Sebastian Houge Date: Sat, 5 Mar 2022 19:10:35 +0100 Subject: [PATCH] Add contributing instructions --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 1c150c3..ca7f9d4 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ - [Built With](#built-with) - [Features](#features) - [Installation](#installation) +- [Contributing](#contributing) - [License](#license) - [Roadmap](#roadmap) - [Contact](#contact) @@ -157,6 +158,31 @@ Once done you will be taken to the login page. Go through the settings page once and change relevant settings before you start adding vehicles and expenses. +## Contributing + +### Dev Setup + +If you want to contribute to the project you need to set it up +for development first. + +Fork and clone the project. Once you have it on your own machine, +open up a terminal and navigate to the `server/` directory. + +In the `server/` directory run the command `go run main.go`. +After some initial +setup, the server should be listening on at port `3000`. + +Next, open a new terminal. Navigate to the `ui/` directory and run `npm install`. +This will install all the dependencies for the frontend. +After the command is done running, run `npm run dev`. After some output, the +frontend should be accessible at `http://localhost:8080`. + +If you are sent straight to the login screen, try closing the page and opening +it again. You should be greeted with a setup wizard the first time you run the +project. + +Now, simply follow the instructions in order to set up your fresh install. + ## License Distributed under the GPL-3.0 License. See `LICENSE` for more information.