search

kolplattformen / skolplattformen

The source code to the civic tech project Öppna Skolplattformen.
https://skolplattformen.org
Apache License 2.0
800 stars 176 forks source link

Walk me through building the app and making a first simple contribution to the project #565

Closed zhouhana closed 1 year ago

zhouhana commented 2 years ago

I tried to follow the instructions in the readme, but got stuck. Please help me out and let's improve the instructions for everyone along the way. Note that I'm still on macOS Mojave since one of my most used apps unfortunately isn't compatible with x64 versions of macOS.

So, first I ran this command:

sudo apt install git npm

Here I was prompted for my password. After filling that in, I got this output:

No Java runtime present, requesting install.

Screenshot 2021-11-30 at 15 06 45

Followed by this popup:

Screenshot 2021-11-30 at 14 58 47

So I clicked More Info… and was taken to https://www.oracle.com/java/technologies/downloads/ Here I could choose between different versions of Java. I had no idea which one to pick but picked the one named x64 DMG Installer. After that one was downloaded, I opened it and double-clicked the icon labelled JDK 17.0.1.pkg.

Screenshot 2021-11-30 at 15 11 28

After having walked through the installation of the JDK, I tried running sudo apt install git npm again but this time got this error:

Unable to locate an executable at "/Library/Java/JavaVirtualMachines/jdk-17.0.1.jdk/Contents/Home/bin/apt" (-1)

Screenshot 2021-11-30 at 15 14 08

So right now I'm stuck there. Help me out please.

viktorlarsson commented 2 years ago

I will go through the installation instructions tonight when the kids are asleep!

believer commented 2 years ago

Awesome that you want to contribute!

apt is more of a Linux thing as far as I know. You can install Node (which contains npm) by downloading an installer from Node.js. We are currently using Node v14.15.4 for the app.

You can then install Git using its installer.

If you are more comfortable using the terminal I would recommend installing Homebrew and using it to install git and node, eg. brew install node.

The official React Native documentation might also hint at any other dependencies you should install.

When you got both set up you should hopefully be able to follow our instructions. Or @viktorlarsson might find something else missing tonight.

Welcome, looking forward to that first contribution 😃

viktorlarsson commented 2 years ago

I have now updated the developer documentation, could you please follow the instructions for your operating system and the app you would like to run and see if it's understandable?

https://github.com/kolplattformen/skolplattformen#getting-started-with-development

viktorlarsson commented 2 years ago

Would also advise you to pull the latest changes from main using git pull origin main