Skip to content

agencik007/beer-catalog-frontend

Repository files navigation

Author information

Hello and welcome to my very first big project. You can check it out on World of beers website.

I divided the project into:

Tech

  • [Typescript]
  • [React]
  • [Redux-tooltkit]
  • [Express.js]
  • [MongoDB]
  • [Mongoose]
  • [Jsonwebtoken]
  • [Axios]

Info

In the future, I will be fixing bugs and adding new functionalities such as:

  • send verification email after register
  • reset password
  • waiting room for admin acceptation
  • comments
  • rating system for all users
  • admin panel
  • searching
  • editing beers

Right now you can:

  • see all beers added by registered users
  • create your own account stored in MongoDB database and secured by password hashing
  • create beer with properties: name, type, rating, description, percentage of alcohol in beer, address with png image
  • delete your beer from page and database
  • use pagination

Configuration

To run this project on your computer you need to follow these steps:

  1. Create a database in MongoDB and a beer-catalog collection where users and beers will be recorded. It is simple to do, you can use the online version of MongoDB Atlas without installing any software. It should looks like this: mongodb-collection

  2. Set the file .env in backend folder and type your credentials.

    NODE_ENV = development

    MONGO_URI = PUT YOUR CONNECTION URI TO MONGODB

    ADMIN_EMAIL = TYPE YOUR EMAIL

    JWT_SECRET = TYPE YOUR SECRET CODE

    PORT = 5000

  3. MongoDB URI is stored in your MongoDB connect tab. You can also specify 'beer-catalog' collection like this: 'mongodb+srv://admin:[email protected]/beer-catalog?retryWrites=true&w=majority' mongo-uri

  4. Add ADMIN_EMAIL and you will be able to create Admin account with permission to delete all beer records.

  5. Set a strong password in the JWT_SECRET field.

  6. In frontend folder you have to check tsconfig.paths.json file and type correct directory for types in backend folder.

Thats all. You can see how it works by run backend with start:dev script and frontend with start script. Enjoy :)

Getting Started with Create React App

This project was bootstrapped with Create React App, using the Redux and Redux Toolkit TS template.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

About

Beer catalog frontend.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published