Giter VIP home page Giter VIP logo

barbershop's Introduction

GoBarber - A barbershop

Containing scheduling, appointments, session and authentication. This app features all the latest tools and practices in web development.

Built with (Backend and Frontend)

  • Express — A web framework for Node
  • Sequelize — SQL dialect ORM for Node.js
  • MongoDB — document-based database
  • Redis — key-value data model
  • Yup - Object schema validation
  • Sentry - cross-platform application monitoring
  • Nodemailer - Send e-mails with Node.JS
  • React — A library to build user interfaces
  • Redux with Redux Saga — State management with middleware
  • CSS — styled-components
  • Reactotron - Helps debugging process
  • Lint — ESlint/Prettier/Editor Config

How to use

Docker is required

  • docker run --name redisbarber -p 6379:6379 -d -t redis:alpine
  • docker run --name mongobarber -p 27017:27017 -d -t mongo
  • docker run --name some-postgres-name -e POSTGRES_PASSWORD=docker -p 5433:5432 -d postgres

⚠️ If you restart your machine, you will need to start again the server with docker start <container_id>.

  1. git clone https://github.com/isabelrubim/barbershop.git
  2. Go to repository folder
  3. Run yarn to install dependencies. (in Backend and Frontend)
  4. Copy the .env.example file and rename it to .env
  5. Add all the values for the environment variables
  6. Run yarn start and yarn queue to run the servers at http://localhost:3333 (in Backend)
  7. Run yarn start to see the example app (in Frontend)

Routes in Backend

  • post('/users') - Create a login
  • post('/sessions') - Log in to an account

Routes - authentication is required

  • put('/users') - Update an account
  • get('/providers') - List providers
  • get('/providers/:providerId/available') - Check provider availability
  • post('/appointments') - Create an appointment
  • get('/appointments') - List all logged-in user's appointments
  • delete('/appointments/:id') - Delete an appointment
  • get('/schedule') - Schedule services
  • post('/files') - Profile pictures
  • get('/notifications') - List all logged in user notifications
  • put('/notifications/:id') - Confirm notification was seen

Made with ♥ by Isabel Rubim

barbershop's People

Contributors

dependabot[bot] avatar isabelrubim avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

barbershop's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.