Smoothly manage your family house
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Just head to our Notion page to understand how to use our platform and have a look at how it is architectured.
To get a local copy up and running follow these simple steps.
After running the knex seeding, you can use the following account for testing purposes on local:
email: [email protected]
password: password
- Install Docker
- Install yarn
- Clone the repo
git clone https://github.com/laperette/laperette
- Install the packages
yarn install
- Launch the local database accessible at
postgres://postgres:postgres@localhost:5430/laperette
docker-compose up -d
- Run the migrations
yarn server migrate
- Run the seeds
yarn server seed
- Launch the server
yarn server start-dev
- Launch the client
yarn client start-dev
See the open issues for a list of proposed features (and known issues).
Any contributions you make are greatly appreciated, especially styling!
- Fork the Project
- Create your Feature Branch using your initials (
git checkout -b am/amazing-feature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin am/amazing-feature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.
Axel Martin - [email protected]
Alexandre Behagel - [email protected]