This is a Back-end part of our Streetcode project. Front-end part: https://github.com/ita-social-projects/StreetCode_Client
The largest platform about the history of Ukraine, built in the space of cities.
To fill the gaps in the historical memory of Ukrainians.
- ASP.NET Core Runtime 6.0.12
- Microsoft SQL Server 2017+
- Nuke Build 6.2.1+
dotnet tool install Nuke.GlobalTool --global --version <VERSION_NUMBER>
environmental variables
spring.datasource.url=${DATASOURCE_URL}
spring.datasource.username=${DATASOURCE_USER}
spring.datasource.password=${DATASOURCE_PASSWORD}
spring.mail.username=${EMAIL_ADDRESS}
spring.mail.password=${EMAIL_PASSWORD}
cloud.name=${CLOUD_NAME}
api.key=${API_KEY}
api.secret=${API_SECRET}
Clone this repo to your local machine using:
https://github.com/ita-social-projects/StreetCode
Or if your have an associated SSH key:
git@github.com:ita-social-projects/StreetCode.git
1. Change connection string
-
Go to
appsettings.Local.json
in StreetCode.WebApi project and write your local database connection string in following format:Server={local_server_name};Database=StreetcodeDb;User Id={username};Password={password};MultipleActiveResultSets=true;TrustServerCertificate=true;
2. Add database seeding
-
Go to
Program.cs
in StreetCode.WebApi project and add following code:await app.SeedDataAsync();
3. Create and seed local database
- Run project and make sure that database was created and filled with data
Run the Streetcode project than open your browser and enter https://localhost:5001/swagger/index.html url. If you had this page already opened, just reload it.
- launch SQL Server management Studio
- In the pop-up window:
- enter "localhost" as the server name;
- select "windows authentication" as authentication mechanism;
- After the connection has been established, right-click on the server (the first line with the icon), on the left-hand side of the UI
- In the the appeared window find and click on "properties"
- In the properties section, select "security" page
- Make sure that "Server authentication" radio-button is set to "SQL Server and Windows Authentication mode"
- Click "Ok"
- Then again, on the left-hand side of the UI find folder entitled "Security", and expand it
- In unrolled list of options find folder "Logins", and expand it
- At this point, you should have "sa" as the last option. If for some reason you do not see it, please refer to https://stackoverflow.com/questions/35753254/why-login-without-rights-can-see-sa-login
- Right-click on the "sa" item, select "properties"
- Change password to the default system one - "Admin@1234". Don't forget to confirm it afterwards
- On the left-hand side select "Status" page, and set "Login" radio-button to "Enabled"
- Click "Ok"
Now you can connect to your localhost instance with login (sa) and password (Admin@1234)!
NOTE: Here's the full walkthrough: https://www.youtube.com/watch?v=ANFnDqe4JBk&t=211s.
- In the "build" project, find the "Targets" folder
- In the appeared list of classes, find and click on "SetupPublicBuild.cs"
- Open the command prompt/PowerShell/linux terminal, go inside of "/Streetcode" directory, and start the "SetupDocker" Target.
cd ./Streetcode
nuke SetupDocker
After waiting for target completion, you should find that the image and running containers for back-end, front-end, db and redis have been successfully created.
NOTE: If order to delete newly created images/containers/volumes, you can utilize the "CleanDocker" Target.
cd ./Streetcode
nuke CleanDocker
That will delete all unnecessary docker-atoms for you.
Run the Streetcode project than open your browser and enter https://localhost:5001/swagger/index.html url. If you had this page already opened, just reload it.
Run the Streetcode project in any other profile but "Local" and enter http://localhost:5000. Now, you are free to test API-endpoints with Postman or any other tool.
Learn more about our documentation here.
Gitflow is a lightweight, branch-based workflow.
Gitflow is an alternative Git branching model that involves the use of feature branches and multiple primary branches.
- First step is checkout to
developer
branch and pull the recent changes.
- π΄ Fork this repo from
developer
branch and name it! A short, descriptive branch name enables your collaborators to see ongoing work at a glance. For example,increase-test-timeout
oradd-code-of-conduct
.
- π¨ On your branch, make ANY reasonable & desired changes to the repository.
- π Commit and push your changes to your branch.
Give each commit a descriptive message to help you and future contributors understand what changes the commit contains.
For example,
fix typo
orincrease rate limit
. Note: you don't need to commit every line of your code in separate commits.
- Before creating pull request you need to check the
developer
branch state! To avoid conflicts, you should mergedeveloper
branch to your local branch! And resolve your local conflicts. Mini manual: checkout to your local branch and write in consolegit merge developer
.
- π Create a new pull request using this link.
- π Assign reviewers! Reviewers should leave questions, comments, and suggestions. After receiving comments, improve the code. Get Approved status on the request and be satisfied with it!
- π After 3 approved reviews, merge your pull request with
developer
branch! Also, it is important to wait for your scrum master to approve your changes. If there are some conflicts, resolve them, again.
- βοΈ Delete redundant branch. Done!
Oops, some fixed needs to be done immediately? Use this guide for Hotfixes!
Some fixes will be needed due to the nature of Gitflow. You would have to do a 'hotfix' or something outside of the normal process, but it's simply part of our normal process.
- π₯ To implement an urgent change, a Hotfix branch is created off the
developer
branch to test and implement the fix.
- π Once itβs complete, the Hotfix is merged with the
developer
branch.
- Π‘an't install .NET Core 6.0.0+ in Visual Studio?
- Try to install Visual Studio 2022
Reach out to us at one of the following places!
- Telegram at
Iryna Zavushchak
- MIT license
- Copyright 2022 Β© SoftServe IT Academy.