Developer Guide: How to get started

LENpolygon / Build-Order-Tool-AoE4-

Build Order Tool (for Age of Empires IV)

30 stars 15 forks source link

Developer Guide: How to get started #38

Open jensbuehl opened 2 years ago

jensbuehl commented 2 years ago

In order to support here and there and try out stuff: Since I (and maybe some other interested developers) do not know how to setup the dev environment properly, get it running and prepare for local testing.

Whoever is "owner" or kicked this project off: Would a tiny bullet point list in the readme.md be possible? Would be highly appreciated.

LENpolygon commented 2 years ago

Hi Jenzb! Thanks for this request and your other posts & interest in this project!

I'm not much of a developer/programmer myself. So it's pretty low tech:

Download the entire Github in a .zip file
Unzip to your folder of choice
Open index.html and see if the website loads (the icons will be replaced to prevent spreading around copyrighted images.)
Edit files with your favorite code editing tool. I like using Visual Studio Code

Html is in main folder and Javascript / CSS are in seperate folders. I've tried splitting up JS in sensible blocks. It's just Vanilla JS. Nothing special.

jensbuehl commented 2 years ago

Thx. :) Maybe I just start a new conversation in the discussions area for specific details, if needed.

JarrettSpiker commented 1 year ago

A quick section on how to set up a firebase config would also be great! The app wont work locally until you have one

davidgamero commented 1 year ago

Good idea- if @LENpolygon wants to confirm it's okay to use the local firebase config or make a dev firebase config I'm happy to write it up!