decafé

deCafé helps users to easily find decaf coffee shops
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

There are many apps to find locations and coffee shops out there, However, none of them can specifically find decaf coffee shops. deCafé is the only App that can provide you with a way to find decaf. Here is why:

• Users should an easier time finding theirs favorite cafes that serves decaf on its menu
• A unique way to connect decaf coffee shops owners to customers
• Because decaf is love, decaf is life Although many features can still be implemented in the future, we believe that its main functionality has been achieved. Thanks to everyone who contributed one way or another for deCafé to become real.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

• Install yarn

  npm install -g yarn

• Install postgres and create database named decafe

  createdb decafe

Installation

1. Clone the repo

   git clone https://github.com/Takashicc/decafe.git
   cd decafe

2. Install packages (root, backend and frontend)

   yarn install
   yarn --cwd backend install
   yarn --cwd frontend install

3. Create tables

   yarn migrate

4. Seed data

   yarn seed

5. Create .env file.

   • Create .env file in backend directory.

     • Set the key and values like below.

       • JWT_SECRET_KEY is for jwt. You can make a secure secret key by running openssl rand -hex 32.

       JWT_SECRET_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxx

6. Run server

   • For developing After running the below command, Go to localhost:3000.

     Note Run the below command at the root of the project.

     yarn dev

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)