Bite Sized 🍴

by Voyage4 Bears16

🍔 Description

Discover, save and share your tastiest recipes.

🍺 Live

App hosted on GitHub Pages (In development:)

🍤 Stack & Tools

• Express - Web framework
• PostgreSQL - Server DBMS
• Bookshelf - SQL ORM
• GraphQL - API query language
• React - Frontend library
• React-Router - Routing library
• TravisCI - Continuous Integration service
• Mocha and Jest - Testing frameworks
• ESLint - Code linter
• Airbnb - Development standards guide
• Heroku - API hosting service
• GitHub Pages - Static frontend hosting service

🍰 Development Setup

Folder structure

• client - Client root
• server - API server root
• server/src/index.js - Express server config
• server/src/test - API server tests
• server/src/config - Config files (database, environment keys, seeds)
• server/src/graphql - GraphQL schemas and resolvers
• server/src/models - Datastore models

Environment

• Clone the repository
• In server/src/config/keys, set dev.js and test.js environment variables using template.js as an example
• cd server && npm install to install server packages
• cd client && npm install to install client packages

Database

• Setup local PostgreSQL database(s) using parameters from /server/src/config/keys
• npm run db-migrate to update database migrations
• npm run db-rollback to rollback database migrations
• npm run db-seed to seed the database
• npm run db-reseed to reseed the database

🍕 Usage

API Server

• npm run test to run all test suites
• npm run test-e2e to run end-to-end tests
• npm run test-unit to run unit tests
• npm run tdd to enable testing watch mode
• npm run start to build and start the server in production environment
• npm run dev to start the server in development environment

Client

• npm run test to run test suites
• npm rnu build to build the client for production
• npm run start to start the client in development environment
• Open app on localhost:3000

See full list in package.json files

🐻 Authors

• Ayumi Saito (Project Manager) 👑
• Fred Hawk
• Thomas Lombart
• Mario Krajacic