Update README.md

README.md

@@ -6,7 +6,7 @@ Welcome to the repository of the Solvro project, a student organization at the W
 
 ## Project Goal
 
-The goal of the Solvro Planner project is to create an intuitive and user-friendly application that helps students plan their academic schedule. The planner is designed to minimize the time spent manually adjusting the timetable while giving full control over the schedule.
+The goal of the Solvro Planer project is to create an intuitive and user-friendly application that helps students plan their academic schedule. The planer is designed to minimize the time spent manually adjusting the timetable while giving full control over the schedule.
 
 ## Current Team
 
@@ -22,19 +22,19 @@ The goal of the Solvro Planner project is to create an intuitive and user-friend
 - React.js
 - Tailwind
 - Typescript
-- Colify
-- Directus CMS
+- Coolify
 
 ## Links
 - https://planer.solvro.pl
-- https://solvro.pwr.edu.pl
+- https://solvro.pwr.edu.pl/portfolio/planer/
+
+## Analitics
 
-## Statistics
+We have analytics available at https://analytics.solvro.pl
 
-Statistics for Solvro Planner version 1.0
-
-[![Statistics](https://i.imgur.com/My4U8lY.png)](https://i.imgur.com)
+For Solvro Planer version 1.0 below.
 
+[![Analitics](https://i.imgur.com/My4U8lY.png)](https://i.imgur.com)
 
 ## Getting Started
 
@@ -55,6 +55,15 @@ cd web-planer
 npm install
 ```
 
+### Fill .env file
+To configure the application, you need to create a .env file in the root directory of the project and fill it with the following environment variables:
+```bash
+SITE_URL=http://localhost:3000
+USOS_CONSUMER_KEY=<your-key>
+USOS_CONSUMER_SECRET=<your-key>
+USOS_BASE_URL=<your-key-default-for-pwr:usos.pwr.edu.pl>
+```
+
 ### Run the Project
 
 After installing the dependencies, run the project locally on your computer:
@@ -75,38 +84,48 @@ If you would like to contribute to the development of this project, we encourage
 - Request features by creating pull requests,
 - Test and provide feedback on the project.
 
-## Contact
+## Github workflow
+Don't worry if you've forgotten about the steps, automatic gh action will run the checks for you and notify if somthing's wrong.
 
-If you have any questions, suggestions, or would like to learn more about the project, contact us:
+## Working with git
 
-- Email: kn.solvro@pwr.edu.pl
-- Website: [solvro.pwr.edu.pl](https://solvro.pwr.edu.pl/)
-- Facebook: Solvro
+### Github Solvro Handbook 🔥
 
-Thank you for your interest in our project!
-
-## Deployment
+https://docs.google.com/document/d/1Sb5lYqYLnYuecS1Essn3YwietsbuLPCTsTuW0EMpG5o/edit?usp=sharing
 
-[Coolify](https://coolify.io/) - An online platform offering the ability to host your own web applications, similar to Heroku, Netlify, or Vercel, but open-source and self-hostable on your own server.
+### SSH
 
-Currently, the site is hosted on a VPS from the IT Department, and it must be renewed every year. For access to Coolify, you should contact @Rei-x, @dawidlinek, @Szymczek, or @karbowskijakub.
+Connecting to Github(Gh) repository via SSH on Windows, tutorial: https://www.youtube.com/watch?v=vExsOTgIOGw
 
-Coolify address: https://devops.solvro.pl
+### Building new feature
 
-For each pull request, a Preview Deployment is automatically created, and Coolify adds a comment with a link to this version.
+1. git checkout main -> checkout main branch
+2. git pull origin main -> pull current changes from main branch
+3. git fetch -> be up to date with remote branches
+4. git checkout -b WEB-x_my_feature_branch -> x - stands for issue number; it is going to checkout and create new branch name WEB-x_my_feature_branch
+   (... working on the feature, we are still on our branch named WEB-x_my_feature_branch)
+5. git add . -> add all changes we have made
+6. git commit -m "My changes description" -> commit made changes with proper description
+7. git push origin WEB-x_my_feature_branch -> pushing our changes to remote branch
+8. On Github we are going to make Pull Request (PR) from our remote branch
 
-Everything on the main branch is automatically deployed to production.
+### Remarks
 
-## CMS
+- Do not push directly to main branch!!! This is bad practice!
+- local branch - is our branch on our computer not on the server if we do some chagnes and do checkout to diffrent branch without saving them(commiting) we might loose them, commit before checkout to different branch!
+- remote branch - this is branch with our code in github's servers
+- After code review which was successful, we can merge from our feature branch to main branch. After merging we should clean after ourself.
 
-We use [Directus CMS](https://directus.io/), available at https://cms.solvro.pl. For access, request the same people responsible for access to Coolify.
+1. git branch -d WEB-x_my_feature_branch -> deletes our local branch
+2. git push origin --delete WEB-x_my_feature_branch -> delete our remote branch
 
-All content is fetched during the build process, and to update things on the site, you need to update them in the CMS and wait for the site to rebuild (this happens automatically as Directus is connected to a webhook in Coolify). You can monitor this in the Deployments tab in Coolify.
 
-## Analytics
+## Contact
 
-We have analytics set up at https://analytics.solvro.pl
+If you have any questions, suggestions, or would like to learn more about the project, contact us:
 
-## Uptime 
+- Email: kn.solvro@pwr.edu.pl
+- Website: [solvro.pwr.edu.pl](https://solvro.pwr.edu.pl/)
+- Facebook: https://www.facebook.com/knsolvro
 
-Monitoring - https://uptime.solvro.pl/status/solvro
+Thank you for your interest in our project!