Bakend
Baking ingredients comparison and substitution app
Install / Use
/learn @SilviaBarcellini/BakendREADME
Bakend 🍩
This is my capstone project for the Neue Fische Web Development Bootcamp attended in Spring 2021
🎬 Demo
<img src="public/Silvia_Barcellini_Bakend.gif"/>📌 Table of contents
- Demo
- Getting Started
- How it works
- Development
- Tests
- Project Dependencies
- Deployment
- Library
- Contacts
🎉 Getting Started
To run locally, install the dependencies and run the development server. First, run the development server:
npm install
npm run dev
Open http://localhost:3000.
Now you should be able to run it in your own device.
📝 How it works
Bakend is a baking ingredients converter app. Turned vegan? Or lactose intolerant? Or maybe just forgot to buy milk? Or just happy to experiment and give a personal twist to your cake recipes?
There is a calculator page for each of the basic baking ingredients, such as butter, sugar and milk.
Just type how much butter, sugar or milk you need according to your recipe and choose among the available options your favourite substitute. Bakend will do the maths for you!
The result you get is calculated using the exchange rate of each ingredient.
Would you like to know more of each ingredient stored in the database? Just visit the "Explore" page of the app. There you can type the name of the ingredient you are interested in. You will get the all the results from the directly from database. For each ingredient stored in the database there are nutrition facts and allergies warnings listed. (The app is for entertainment purposes only and never replaces a physician's advice. Please check the label of each product before you purchase it.)
💻 Development
🌟 Highlights
- TypeScript
- React
- Next.js
- mongoDB
- Storybook
✔️ Prerequisites
None! Just install all dependencies and you are good to go!
💞 Contribute
Would you like to contribute? Feel free to ✨ add features or 🐛 fix bugs!
git clone git@github.com:SilviaBarcellini/bakend.git
cd bakend
npm install
npm run dev
✅ Tests
No tests implemented yet.
➕ Project Dependencies
- https://nextjs.org/learn/excel/typescript
- https://prettier.io/docs/en/install.html
- https://eslint.org/docs/user-guide/getting-started
- https://github.com/prettier/eslint-config-prettier
- https://stylelint.io/user-guide/get-started
- https://github.com/prettier/stylelint-config-prettier
- https://typicode.github.io/husky/
- https://github.com/okonet/lint-staged
- https://storybook.js.org/docs/react/get-started/install
- (https://www.npmjs.com/package/storybook-css-modules-preset)
- Custom server for next
- TypeScript for custom server + nodemon
🚀 Deployment
The game is deployed on Heroku. Play it here: Bakend.
For a better experience use the mobile version, although it works in browser too.
📚 Library
Icons from flaticon. For more info, please visit the Credits page of the App.
💌 Contacts
Got anything to say? Please feel free to contact me!
<img src="public/silvia_barcellini_bakend.png" alt="bakend_landing_page"/>