Foodie Express Project
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Foodie Express is a modern food delivery web application designed to connect hungry customers with their favorite local restaurants, while also empowering users to become restaurant owners themselves.
With a sleek and user-friendly interface, customers can easily browse through a variety of cuisines, place orders, and track deliveries in real-time. Our platform not only streamlines the food ordering process but also provides an opportunity for users to create their restaurants, add cuisines, and monitor/approve orders made by other users.
Frameworks and tools that were used to develop Foodie express.
Instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
- Clone the repo
https://github.com/JohnKamaujk/foodie-express.git
- cd into the frontend folder
cd frontend/ - Install NPM packages
npm install
- Create a dot env file inside the frontend folder and set up env variables
VITE_API_BASE_URL= VITE_AUTH0_DOMAIN= VITE_AUTH0_CLIENT_ID= VITE_AUTH0_CALLBACK_URL= VITE_AUTH0_AUDIENCE=
- cd into the backend folder
cd backend/ - Install NPM packages
npm install
- Create a dot env file inside the backend folder and set up env variables
MONGODB_URI = AUTH0_AUDIENCE= AUTH0_ISSUER_BASE_URL= CLOUDINARY_CLOUD_NAME= CLOUDINARY_API_KEY= CLOUDINARY_API_SECRET= FRONTEND_URL= STRIPE_API_KEY= STRIPE_WEBHOOK_SECRET=
- Then run both the backend and frontend servers using
npm run dev
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more information, please refer to the Video Demo
- Add Changelog
- Add back to top links
- Add Additional Templates w/ Examples
- Add "components" document to easily copy & paste sections of the readme
- Multi-language Support
- Chinese
- Spanish
- French
See the open issues for a full list of proposed features (and known issues).
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 PROJECT 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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Repo Owner Name - Johnny K
Project Link: https://github.com/JohnKamaujk/foodie-express
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!