README

Create and organize personalized lists all in one place.

Listreme is a listing platform that allows users to create various lists based on anything of their choosing. With Listreme, users can also interact with each other, where they can follow users, favorite lists, and much more.

Installation

1. Create a new project: composer create-project seramity/listreme PATH -s alpha
2. Add credentials in .env
3. Install database: ./vendor/bin/phinx migrate

Contributing

If you would like to contribute to Listreme's development, we would appreciate anything from simple bug fixes to implementing new features. We'll be glad to work with whatever that is proposed to us if appropriate.

Bug Fixes

If you would like to report a bug in Listreme, please create a new issue (if the issue doesn't already exist) and clearly explain the following:

• Description of the bug
• How and where it happens
• How to reproduce the bug
• If applicable, which platforms does it appears on (browser and/or operating system)

Pull Requests

To get started on submitting a new feature, please do the following:

1. Fork the repo
2. Create a new branch: git checkout -b feature-FEATURENAME (Please use the conventional feature branch names when submitting a feature)
3. Commit changes: git commit -am "COMMIT MESSAGE"
4. Push your changes: git push origin feature-FEATURENAME
5. Create pull request

TODO

Listreme's development can be followed at our official Trello board.