A sky map tool designed for enthusiasts of the astronomy. You can learn the shapes of the celestial sphere which is divided into three regions: north, equator and south. That can help you to concentrate on part of the night sky that is visible from your location. This constellation app contains two modes: one for learning and second for training of your current skills.
The ConstellationMind.Api is a REST API, containing core features for Android Application called Constellation Mind.
Branch | Build & Tests |
---|---|
master | |
develop |
You will need the following tools:
- Visual Studio Code or Visual Studio,
- .Net Core (Please check if you have installed the same runtime version (SDK) described in
/src/ConstellationMind.Api/*.csproj
), - MongoDB (3.6.3 version or higher).
Follow these steps to get your development environment set up:
- Clone the repository.
- At the root directory, restore required packages by running:
~$ dotnet restore
- Next, build the solution by running:
~$ dotnet build
- Start the MongoDb service (by default it will be available under
mongodb://127.0.0.1:27017
)
4.1. Linux setup:
Start the MongoDb service using the following command:
~$ sudo service mongodb start
4.2. Windows setup:
Create the following folderC:\data\db
To start MongoDB, runmongod.exe
using the following command:
~$ "<your_installation_path>\MongoDB\Server\4.0\bin\mongod.exe" --dbpath="c:\data\db"
. - Finally, service can be started locally within
/src/ConstellationMind.Api
directory (by default it will be available underhttp://localhost:5000
) using the following command:
~$ dotnet run
You can also run the application using Docker:
- Start the MongoDb service:
~$ docker run --name mongo -d -p 27017:27017 mongo:3.6
- Run the application:
~$ docker run -d -p 5000:5000 --name constellation-mind constellation-mind-api --network const-mind
*to run the container in the background use -d
switch.
- Or using Docker compose:
3.1. Create a newdocker-compose.yml
file or use an existing which can find here.
version: "3.7"
services:
api:
build: dockerfile_location
container_name: name
depends_on:
- mongo
ports:
- '5000:5000'
networks:
- network_name
mongo:
image: mongo:3.6
container_name: name
ports:
- 27017:27017
networks:
- network_name
volumes:
- mongo:volume_location
networks:
network_name:
name: name
volumes:
mongo:
driver: local
3.2. In order to start it, execute the following command:
~$ docker-compose up