Frontend for GeoCode written in Vue 2 and Typescript. GeoCode was written as project for the course Web Development 2020 at the University of Ghent
Backend Repository: GeoCode Backend
Find & create amazing locations to explore and share with others. GeoCode is the new way of Geocaching you have been dreaming of.
You will need to install node.js. Make sure that your Node.js installation includes NPM
You will also need to install yarn. You either install it from the official website, your package manager, or use the NPM command:
npm install yarn -g
You will also need to install the Vue CLI
npm install -g @vue/cli
- Clone the repository.
- Enter the created directory.
- Execute the following command to install the projects dependencies:
yarn install
- Copy the
.env.templatefile and name it.env.localor.env. Make sure to apply the correct settings inside the created file.
To start a development server, run:
yarn serve
This should start an instance of the server on a given port.
To compile the production build, run:
yarn build --mode production
This project relies heavily on [ESLint][eslint] and [Prettier][prettier] to enforce consistent formatting and coding styles. A [pre-commit-hook][precommit] runs every time you try to commit, linting and reformatting the staged files. This allows you to basically forget about formatting, prettier is much better at it anyway.
Tip: you can setup your editor to run eslint --fix on save, to see the formatting changes sooner. This allows you to write code like an absolute monster, all on one line even, hit save, and watch the magic happen.
Some of the eslint rules may seem a bit harsh. If there is one that particularly annoys you, please open an issue to discuss it.
We try to follow the BEM conventions for naming css classes.
Inline styling should be avoided at all cost!