Skip to content

Latest commit

 

History

History
106 lines (90 loc) · 6.95 KB

README.md

File metadata and controls

106 lines (90 loc) · 6.95 KB
Raw

codeforpoznan.pl_v3

deploy to staging Join Slack

General Overview of the Project

This is internal project maintained by our community for our community.

First, we maintain the landing page that contains information about our community and the projects we carry out for other organizations that help them do good more easily or efficiently. They don't have much money and software development is expensive. We simply try to bridge that gap with our voluntary work to balance the scales.

Second we develop the intranet for our community. We try to create the tools which can help us organize ourselves better by storing the relevant information in one place, streamlining our practices and managing our responsibilities. If you want to learn the general direction we try to accomplish, here you'll find the general description of features we pursue at the moment: Features we currently pursue

Wanna help us develop the product?

How to get started

Join codeforpoznan_v3 channel on our slack - this is the place where we discuss all the issues and help each other by sharing tips and knowledge. You can also ping OtisRed on github or @Otis in the slack DM if you need any help.

0. For Windows users - WSL setup instruction

1. Fork the repository onto your github account. Go to your account and open repo you just copied. Find the "Code" button and copy HTTPS adress unless you're using SSH or GitHub CLI. Then:

# Open the terminal, choose the location on your computer where you want to keep it and paste in the command: 
git clone https://github.com/YOUR_USERNAME/codeforpoznan.pl_v3.git

This way any commit you push will affect only your fork (so you can break anything you like).

2. Install docker to run the app locally on your computer. Follow this guide to integrate docker with WSL and VS code.

#Install essential packages needed to build an application
sudo apt-get install build-essential

Next,

# Once you install docker, go to the location of the repo on your computer and run command: 
sudo make start

Now you'll be able to access Frontend in you browser tab under the URL: localhost:8080 and push requests to backend on localhost:5000 (if you don't want to use sudo follow the instructions here).

3. Choose a task from one if the lists below

Please leave a comment that you're gonna work on it.

4. Create a new branch for your commits

We like to keep master branch clean so:

# create a new branch and name it descriptively starting with number of your task e.g. "123_UPDATE_SOMETHING":
git checkout -b 123_BRANCH_NAME
# Then, switch to your new branch that branch with command: 
git checkout 123_UPDATE_SOMETHING

Now you can start developing and commiting your changes!

5. Push your changes to main repo

Once you're finished, run four commands to commit your changes.

# First check your changes:
git status
# which will print the list of files you altered.
#add changed files to your commit: 
git add NAME/OF/THE.FILE
# Then wrap the commit and describe what's happening there:
git commit -m "BRIEFLY DESCRIBE YOUR CHANGES"
# Finally push the commit to your forked repo:
git push origin 123_UPDATE_SOMETHING

Then, go to our repo here, make "new pull request" and find your branch on "compare" list. Provide a short description of the changes you made and "create pull request" so that others could review your code.

Wanna start with somthing simple?

Wanna work on something more advanced?

Documentation

You may want to familiarize yourself with our:

You will find more documentation on these and other more specific topics in the docs folder.