laperette Goto Github PK

Smoothly manage your family house
Explore the docs »

View Demo · Report Bug · Request Feature

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact

Just head to our Notion page to understand how to use our platform and have a look at how it is architectured.

• Typescript
• React
• Koa
• PostgreSQL
• Knex

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

1. Clone the repo

git clone https://github.com/laperette/laperette

2. Install the packages

yarn install

3. Launch the local database accessible at postgres://postgres:postgres@localhost:5430/laperette

docker-compose up -d

4. Run the migrations

yarn server migrate

5. Run the seeds

yarn server seed

6. Launch the server

yarn server start-dev

7. 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!

1. Fork the Project
2. Create your Feature Branch using your initials (git checkout -b am/amazing-feature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin am/amazing-feature)
5. Open a Pull Request

Distributed under the MIT License. See LICENSE for more information.

Axel Martin - [email protected]

Github - LinkedIn

Alexandre Behagel - [email protected]

Github - LinkedIn