Skip to content

chinhtrung/kitzzen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

326 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

kitzzen: start a business at your kitchen

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

kitzzen home page screenshot kitzzen product page screenshot kitzzen user page screenshot

This side project is motivated by the idea of building a platform for users to buy food from local kitchen and also a place local kitchens display their food to sale. Many people have very high cooking skill and kitzzen provides a market place where they can sell their food without opening a restaurant.

Built With

Backend

Frontend

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Install npm to your local machine

  • npm
    npm install npm@latest -g

Installation

  1. Clone the current repo
    git clone https://github.com/chinhtrung/kitzzen.git
  2. Install NPM packages
    npm install
  3. Install nodemon globally
    npm install nodemon
  4. Setup your enviroment variables/secrets and save it inside .env file
    cat > .env
    PORT=8080
    IP=<your_ip_address>
    DATABASEURL=<your_databaseurl>
    
    CLOUD_NAME=<your_cloud_name>
    CLOUDINARY_API_KEY=<your_cloudinary_api_key>
    CLOUDINARY_API_SECRET=<your_cloundinary_api_key>
    
    GMAIL=<your_email>
    GMAILPW=<your_email_password>
    ADMIN_CODE=<your_admin_code>
    
    MAPBOX_TOKEN=<your_mapbox_token>
  5. Start the server
    nodemon app.js
  6. Open your localhost at port 8080 on your web browser localhost:8080

Usage

  • Post your food online with location and time available for others to see and book
  • Look for foods to eat from local kitchens
  • Discuss with your customer about shipping method (either pickup or deliver)

Roadmap

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

Contributing

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

  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

License

Distributed under the MIT License.

Contact

Trung Nguyen - chinhtrung596@gmail.com

Project Link: https://github.com/chinhtrung/kitzzen

Acknowledgements

Have fun 😄

About

Kitzzen - Start a business at your Kitchen, an online home cook selling website

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors