Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 3.79 KB

README.md

File metadata and controls

72 lines (48 loc) · 3.79 KB
Raw

StudentAssistant

Build Status Pull Requests Issues License Size Code Coverage

Project

Student Assistant - this is a web service with an open source project. The created for a convenient and flexible way to monitor the study schedule.

You can try use it here: http://studyass.site

Overview

Schedule

Student Assistant provide service education schedule for students. With help calendar widget user can choose need date time for getting schedule on day.

The schedule tab looks like this:

So in the screenshot below you can see what can Student Asssitant application. For example, thanks tag <input /> you can use native implementation calendar in browser or mobile or thanks other npm packages you can use popup window and calendar widget.

Supports all browsers, including an Internet Explorer (not without problems, but it works).

Compiling

To compile and run the application on Linux or Windows, you need to download and install latest .NET Core SDK, install Node.js and clone the repository using Git. Then, go into StudentAssistant.Backend and StudentAssistant.Frontend directory and run dotnet run command. Or you can use build scripts:

  1. For Linux or MacOS shell:
# Linux or MacOS shell.

git clone https://github.com/boogiedk/StudentAssistant
cd ./StudentAssistant && bash ./build.sh

# Go into `StudentAssistant.Backend` and `StudentAssistant.Frontend` directory and run `dotnet run` command
  1. For Windows command line:
# Windows command line.
# Use the '--configuration Release' option to generate app packages.

git clone https://github.com/boogiedk/StudentAssistant
cd ./StudentAssistant && powershell -ExecutionPolicy Unrestricted ./build.ps1

# Go into `StudentAssistant.Backend` and `StudentAssistant.Frontend` directory and run `dotnet run` command

Contributing

Contributors are welcome. Please submit an issue before introducing new features, then you might create a "work in progress" (WIP) pull request to prevent other people from working on the same feature. Dev group is here: studyAssTalks, please feel free to ask questions. If you are new to this project there are some entry-level issues marked with "good first issue" tag. Also you can visit kanban board Trello and watch for roadmap develop.

Technology stack