Skip to content

Commit

Permalink
SLCOL-45: Update README and CONTRIBUTING (#82)
Browse files Browse the repository at this point in the history
* SLCOL-45: Update README and CONTRIBUTING

* SLCOL-45: Remove shadows from collectio_v1.png
  • Loading branch information
campovski authored May 16, 2020
1 parent ee0f9c8 commit 4e6d42b
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contriguting guidelines

This document contains rules on how to open a new issue or pull request.

## Opening an issue

Everyone is welcomed to open an issue with a suggestion for new feature or bug report.

## Opening a pull request

Opening a pull request is a bit more complicated. Any pull request opened must have a corresponding issue. Each pull request must have a resolving keyword with issue number in the body, so that when pull request is closed, issue is automatically closed. The title of pull request must be matching the title of the issue it is resolving (it will later be merged via _Squash and merge_ option).
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,50 @@
![](misc/collectio_banner.png)

# Stelynx Collectio

_Application for passionate collectors and people that want to keep track of certain things like myself. Written in Flutter and available on iOS and Android._

![Lint & Test](https://github.com/stelynx/collectio/workflows/Lint%20&%20Test/badge.svg)
![Build iOS](https://github.com/stelynx/collectio/workflows/Build%20iOS/badge.svg)
![Build Android](https://github.com/stelynx/collectio/workflows/Build%20Android/badge.svg)
[![codecov.io](https://codecov.io/gh/stelynx/collectio/branch/develop/graphs/badge.svg)](https://codecov.io/gh/stelynx/collectio/branch/develop)

## Who is this application meant for

This application is meant for collectors, but in no case its usage is limited to collectors only. This application can be used for any kind of keeping track of large ammount of numbers. You can keep track of books that you have at your home library or the books you have read, recipes of the dishes you have prepared, the hikes and climbs you have made, the beer you have tasted, cities you have visited, etc. You can even use it for your own diary!

So, this application has a broad usage, and that's why I like it. On one hand, you do not need a different application for diary, recipes, beer reviews, and collections, but you can rather store them in one neatly organized and content way using this application.

## How it all started

I am a passionate collector of various things, from stamps, Euro coins, world banknotes and coins, to beer reviews, books, and recipes. One cannot really call a list of recipes "collecting", but for me collecting does not necessarilly need to contain an underlying physical thing.

I used to have a blog with beer reviews. It was written in Python using Django and hosted on my old Mac Mini at home. But some day I managed to corrupt the filesystem not thinking I do not have a backup for my database. And so I lost all the data ... Also, that blog only had a Django admin panel where I could add more reviews, therefore it was a bit of a pain in the ass to use it on phone. The poor old guy is [beernburger](https://github.com/campovski/beernburger).

It was few months ago that I heard of Flutter and started learning it right away. I did not have an idea for a project at the very beginning, but then I remembered about my collecting passion and I said to myself, would it not be wonderful if I had an app where I could keep track of my collections.

## User interface

The idea behind design is a very simple one. Use default Material design widgets in Flutter, since Material is awesome, apple few basic stylings on them and we are good to go.

This was the plan for user interface for version one, when the most effort went into learning Flutter and "best architecture".

### Version 1

![](misc/collectio_v1.png)

## Future plans

The application has a lot of potential, therefore it is far from being finished. There is so much one can still learn from implementing it, from complex user interface, to additional functionality, personlized preferences and themes, etc.

The plan for the (near) future can clearly be seen by looking at [issues](https://github.com/stelynx/collectio/issues). Every new feature that crossed my mind or improvement is written as a separate issue. Milestones are used to mark the "priority" of the task, by specifying in which version a feature will be implemented.

## Contributing

Since this is an open-source project, everyone is welcomed to contribute, by opening an issue or even a pull request. However, please read [contributing guidelines](CONTRIBUTING.md) first!

## Acknowledgements

Special thanks go to

- [@felangel](https://github.com/felangel) for helping me with testing BLoC.
File renamed without changes.
Binary file added misc/collectio_banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added misc/collectio_v1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 4e6d42b

Please sign in to comment.