docs: update README.md
This commit is contained in:
parent
2a2c183f8c
commit
f4bc77dfc1
55
README.md
55
README.md
@ -1,40 +1,47 @@
|
||||
## auto.bus (Ticket Office) – manage, search and buy bus tickets online
|
||||
# auto.bus – Ticket Office web application
|
||||
|
||||
- C#, Microsoft.EntityFrameworkCore, Razor Pages
|
||||
You can do the following:
|
||||
|
||||
### Installation
|
||||
- Search for routes by departure/arrival city and date
|
||||
- Filter routes by number, duration and date
|
||||
- Print ticket in pdf format
|
||||
- Buy tickets
|
||||
- Manage routes (create, read, update and delete) on admin account
|
||||
|
||||
To build and then run compiled project use `[~]$ sh run.sh`
|
||||
## Project preview
|
||||
|
||||
### Security
|
||||
<div style="display: flex;">
|
||||
<img src="http://drive.google.com/uc?export=view&id=1ltCPim1sfg9Rq_4MPqs97QOc_nU_Cfqj" alt="Search route page" width="480" height="233" border="10" />
|
||||
<img src="http://drive.google.com/uc?export=view&id=1wJKDHYI9KuWQjcS70o13UmDqliayA31X" alt="My tickets page" width="480" height="233" border="10" />
|
||||
</div>
|
||||
|
||||
## How to install?
|
||||
|
||||
The program is built for educational purposes and will not be used in the production.
|
||||
But if you want to host the web app be shure to comment/delete 30'th line in Program.cs
|
||||
### Linux
|
||||
|
||||
### Miscellaneous
|
||||
1. [Download](https://dotnet.microsoft.com/download) and install .NET with ASP.NET Core
|
||||
2. Clone this project
|
||||
3. Run run.sh file in terminal `[~]$ sh run.sh`
|
||||
|
||||
You can disable miscellaneous features by commenting 30'th line in Program.cs
|
||||
NOTE: use `[~]$ sh run.sh --help` to see available options
|
||||
|
||||
#### Available routes
|
||||
## How to tweak this project for your own uses?
|
||||
|
||||
##### № 027
|
||||
- You can tweak `~/TicketOffice/Models/SeedData.cs` to fill up empty sqlite3 database with your data
|
||||
- You can comment lines 28, 29 and 30 in `~/TicketOffice/Program.cs` to disable data seeding
|
||||
|
||||
- Сватове -> Красноріченське -> Кремінна -> Рубіжне -> Сєвєродонецьк -> Лисичанськ -> Сєвєродонецьк -> Рубіжне -> Кремінна -> Красноріченське -> Сватове
|
||||
- (Date: date of the first launch of project with clean database)
|
||||
## How to contribute?
|
||||
|
||||
##### № 013
|
||||
If you want to add a feature, you should follow these steps:
|
||||
|
||||
- Кремінна -> Рубіжне -> Сєвєродонецьк -> Станиця Луганська -> Сєвєродонецьк -> Рубіжне -> Кремінна
|
||||
- (Date: date of the first launch of project with clean database)
|
||||
1. Fork the project
|
||||
2. Make some changes and commit them with [conventional commit message](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/)
|
||||
3. Submit a PR with a new feature/code
|
||||
|
||||
#### Test accounts
|
||||
## Find a bug?
|
||||
|
||||
##### User
|
||||
If you found an issue or would like to submit an improvement to this project, please submit an issue using the issues tab above. If you would like to submit a PR with a fix, reference the issue you created!
|
||||
|
||||
- e-mail: user
|
||||
- password: user
|
||||
## Known issues (Work in progress)
|
||||
|
||||
##### Admin
|
||||
|
||||
- e-mail: admin
|
||||
- password: admin
|
||||
- The route management page will not load if database contains a route with an empty departure/arrival city date
|
||||
|
Loading…
Reference in New Issue
Block a user