Getting Started
To get started you will have to follow a few steps.
1. Install proper tools
Make sure your operating system has the proper tools for development.
Download and install the following tools according to the operating system and architecture that you use:
Nodejs
Git
2. Clone the repository
Make sure you have access to the Urapolku git repository and clone the repository into a directory of your choosing.
change directory into the directory you want inside your favourite command line terminal, or use a tool like:
Github Desktop
To clone the repository.
To do it from within a terminal, run the following command:
After you've cloned your repository, you'll want to switch to the Development branch
Ask your superior what you should work on, and when he/she has told you what you can work on, create a feature branch for the feature you will be working on.
Name it in the following convention:
Dev-FeatureName
So that other developers know you are working on a feature within Development. When your feature is finished, it will be merged into the Development branch.
3. Setup Environment variables
Go to the discord server that you are invited to for Urapolku and check out the channel: #environment-variables
Make sure you put these environment variables into a local file in the root of the folder called: .env.local
4. Start Developing
Since you have Nodejs installed, you should be able to run the following 2 commands:
npm install
npm run dev
Go through our entire documentation to find out how to work with this project, and also check out the documentation for the tools, platforms and frameworks that we use.
Last updated
Was this helpful?