1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
# DevHive
DevHive is the social network solution for programmers. In it you can make posts to share with your friends, comment and more.
This is the back-end portion of the project, built with [`ASP.NET Core`](https://docs.microsoft.com/en-us/aspnet/core/introduction-to-aspnet-core?view=aspnetcore-5.0). For the front-end, refer to [DevHive-Angular](https://github.com/Team-Kaleidoscope/DevHive-Angular).
In the `docs` folder you can find relevenat information and documentation about this project. You can also find our [Privacy Policy](https://github.com/Team-Kaleidoscope/DevHive/wiki/Privacy-Policy).
## Contents:
- [Setting up locally](#setting-up-locally)
- [Prerequisites](#prerequisites)
- [Getting started with the database](#getting-started-with-the-database)
- [Starting up](#starting-up)
- [Important notes](#important-notes)
- [Screenshots](#screenshots)
## Setting up locally
There currently aren't any demo instances, so the only way to try it out for yourself it to set it up locally, on a computer or server. In this section are explained the steps to do so.
The steps are oriented around Linux-based systems.
### Prerequisites
There are some tools you need to setup before even downloading the app:
- [`dotnet 5.0`](https://docs.microsoft.com/en-us/dotnet/core/install/linux) or later
- [`Entity Framework Core tool 5.0.2`](https://docs.microsoft.com/en-us/ef/core/cli/dotnet) or greater
- if you've already installed `dotnet`, you can just run this command `dotnet tool install dotnet-ef -g`
- [`postresql 13.1`](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04) or greater (older versions might work, but haven't been tested)
- Fedora users could also refer to [this](https://computingforgeeks.com/how-to-install-postgresql-12-on-fedora/) guide
- Arch users can refer to the [ArchWiki](https://wiki.archlinux.org/index.php/PostgreSQL)
### Getting started with the database
After installing all of the tools and setting up the database, you should have a user with a password with which to access postgres and you should have [created a database](https://www.tutorialspoint.com/postgresql/postgresql_create_database.htm) for the API. If so, follow these steps:
1. Clone the repository: `git clone https://github.com/Team-Kaleidoscope/DevHive.git`
2. Navigate to the folder, in which you cloned it, and then go to `src/Data/DevHive.Data`
3. Edit the file `ConnectionString.json` and replace the default values with what you've setup
4. In the same directory, run `dotnet ef database update`
### Starting up
1. Navigate to the `src/Web/DevHive.Web` folder
2. Edit the `appsettings.json` file, under "ConnectionStrings", type in the values, you setup in `ConnectionString.json`
- On the third row there is a "signingKey" field, it's used for encryption of User passwords. **It must be made up of 64 letters and number!** On the next two rows you also need to set a "validationIssuer" and "audience", you can set these values to whatever you want.
- There are also some cloud values that you can change. Currently, the project uses [Cloudinary](https://cloudinary.com/) as a place for uploading files. If you wish, you can setup your own account there, otherwise file uploading won't work.
3. Run `dotnet run`
- feel free to [run the command in background](https://linuxize.com/post/how-to-run-linux-commands-in-background/) or [create a systemd service](https://medium.com/@benmorel/creating-a-linux-service-with-systemd-611b5c8b91d6)
If everything went well, you can now access the API on `http://localhost:5000/api` with something like [Postman](https://www.postman.com/) or the FOSS alternative [Insomnia Designer](https://github.com/Kong/insomnia). On where to send requests, refer to the "API-Endpoints" page in docs.
### Important notes
You can change on what port the API is ran, by changing the `HTTP_PORT` constant in `src/Web/DevHive.Web/Program.cs`. If you do so, you **must** also update the front-end, because by default it will try to send requests to `http://localhost:5000`.
|
