Class 38-GROUP01 final project : Komje

This is the final project for the HackYourFuture curriculum we did as a class using the MERN stack by following the agile methodology with our team and a group of mentors. A quick guide to what we built:

Komje

We know how important and valuable every minute of your dream day. So, why do not you save yourself the stress while getting ready for your wedding? Komje is here for you.

Ask all your questions about the guests, easily share the invitation online and see the answers with a chart.

Our online invitations will continue to do more than just save paper. Together we can invite a greener future.

Click here for the Demo version

Built with

1. Setup

First, to setup all the directories run the following in the main directory:

npm install

npm run setup

The first command will install cypress and some small libraries needed for running the rest of the commands. The second will go into the client and server directories and set those up to be ran.

In the client and server directory there are two .env.example files. Create a copy and rename that to .env. Then follow the instructions in those files to fill in the right values.

To run the app in dev mode you can run the following command in the main directory:

npm run dev

2. Code structure

client
├── public
└── src
|   └── __tests__
|   └── __testUtils__
|   └── components
|   └── hooks
|   └── pages
|       └── __tests__
|       └── components
|   └── util
|   index.jsx
cypress
|   └── fixtures
|   └── integration
|   └── plugins
|   └── support
server
└── src
    └── __tests__
    └── __testUtils__
    └── controllers
    └── db
    └── models
    └── routes
    └── util
    index.js

2.1 Client structure

public || public facing client code
__tests__ || any jest tests for specific components will be in a __tests__ folder on the same level
__testUtils__ || any code that is only being used in the tests is put in the __testUtils__ folder to separate that away from the rest of the code
components || all of our shared components that are used over multiple pages
hooks || all of our custom hooks
pages || the page components of our app, any routing will go between these components
pages/components || components used specifically on those pages
util || any utility functions that can be used anywhere on the client side
index.jsx || the start point of the client

2.2 Cypress structure

fixtures || any data/files that cypress needs can be placed here
integration || all of our tests are in here, separated in folders based on the pages in our app
plugins || any plugins for our cypress configuration can be placed here
support || custom commands and other support files for cypress can be placed here

2.3 Server structure

__tests__ || any jest tests for the api endpoints as that is our testing strategy for the backend
__testUtils__ || any code that is only being used in the tests is put in the __testUtils__ folder to separate that away from the rest of the code
controllers || all of our controller functions that interact with the database
db || all of our configuration for the database
models || all of our mongoose models will be placed here
routes || code to match up the API with our controllers
util || any utility functions that can be used anywhere on the server side
index.js || the start point of the server

3. Stack / external libraries

The base stack of the app is a MERN stack (Mongoose, Express, React, Node). Next to that we make use of the following extras:

3.1 Configuration libraries

dotenv || To load the .env variables into the process environment. See docs
webpack / html-webpack-plugin || To bundle our React app and create a static app to host. See docs
husky || To run our tests and linter before committing. See docs
eslint || To check our code. We have different configurations for frontend and backend. You can check out the configuration in the .eslintrc.(c)js files in the respective client and server folders. See docs
prettier || To automatically format our code. See docs
concurrently || To run commands in parallel. See docs

For more information on how these work together including the automatic deployment to heroku, have a look at our detailed DEV file.

3.2 Client-side libraries

@testing-library/* || We use React Testing Library to write all of our tests. See docs
jest || To run our tests and coverage. See docs
jest-fetch-mock || To mock out the backend for our testing purposes. See docs
prop-types || To type-check our components. See docs
react-toastify || React-Toastify allows you to add notifications to your app with ease. See docs
react-social-icons || A set of beautiful svg social icons. docs
react-router-dom || It is enables you to implement dynamic routing in a web app. It allows you to display pages and allow users to navigate them. docs
react-icons || Include popular icons in React projects easily use with react-icons. docs.
chart.js || The most popular charting library.See docs
bootstrap ||For syntax for template designs. See docs
@fortawesome/react-fontawesome|For icons and design. See docs

3.3 Server-side libraries

nodemon || To automatically restart the server when in development mode. See docs
jest || To run our tests and coverage. See docs
supertest || To more easily test our endpoints. See docs
mongodb-memory-server || To mock out our database in our backend tests. See docs
cors || To open up our API. See docs
mongoose || To add schemas to our database. See docs
yamljs || Parser and encorder. See docs
swagger-ui-express || It allow to serve auto-generated swagger-ui generated API docs from express, based on a swagger.json file. See docs
nodemailer || It allows to easy as cake email sending. See docs
passport || It is Express-compatible authentication middleware for Node.js.. See docs
passport-jwt || authenticating with a JSON Web Token. See docs
nanoid || URL-friendly, unique string ID generator. See docs
ejs ||? EJS is a simple templating language that lets you generate HTML markup with plain JavaScript. See docs

B1gB4dB4ng / Komje-