Skip to content

deens-com/frontend

Repository files navigation

deens.com

Book curated trips in minutes.

CircleCI

This is the repository for the frontend of deens.com. This project was bootstrapped with Create React App and then later moved over to React app rewired.

πŸ— Development

$ git clone git@github.com:deens-com/frontend.git
$ cd frontend

# install dependencies
$ yarn

We have some yarn specific code in our package.json so we recommend that you use yarn for package management with this repo.

# export the backend endpoint to use
$ export REACT_APP_PARSE_SERVER_URL=https://staging-api.deens.com

# start the web app
$ yarn start

🎨 Guidelines

This project have been changing it's structure along it's way. If you are using Redux please look at /store/trip-designer as a reference. Redux just saves global state. If it's well used it's very useful, but it can be a pain if you use it wrong. So if you don't need it, avoid it.

The entry point of the app is /main/app.js.

If you want to create a new route go to /main/router. We use to map a route to a component in /scenes. You can create your whole component there or (as we did before) link to a component in /styled_scene.

Most reusable functions are in /libs but you may find some in other files. There's no special reason for that. They should be in /libs. Reusable components are in /shared_components. Be careful when modifying them, as you may break other part of the application.

We use Prettier to format the code for this repo. Before committing, please run yarn prettier-all to format your code or add Prettier to the pre-commit hook to automatically take care of formatting.

Unfortunately, tests are broken. The /cypress dir is not useful, but it's there as a reference in case we wanted to make integration tests again.

How to add Prettier to pre-commit hook?

$ touch .git/hooks/pre-commit
$ chmod +x .git/hooks/pre-commit
$ echo '''#!/usr/bin/env bash

yarn lint-staged''' > .git/hooks/pre-commit

😱 Troubleshooting

If you're stuck somewhere while working on something, create an issue and we'll help you out.

πŸŽ“ License

Licensed under the GNU public license V3.0. See LICENSE for more information.

πŸ‘ Big Thanks

Cross-browser Testing Platform Provided by Sauce Labs along with some great Open Source ❀️

About

πŸ’œ Book curated trips in minutes https://deens.com

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages