Skip to content

Latest commit

 

History

History
65 lines (36 loc) · 3.47 KB

README.md

File metadata and controls

65 lines (36 loc) · 3.47 KB
Raw

Bookworm

An online book review application made with the MERN tech stack.

Tech Stack, Dependencies

We utilize the MERN Tech Stack, and version 5 of the TypeScript programming language for type safety.

This project utilizes several other libraries and dependencies. See the package.json in each of the backend and frontend directories for more information on additional dependency versions.

In the frontend and backend directories, run npm i to install all dependencies needed for the project.

Getting Started

Contributing

  1. Clone the repository
  2. For both the backend and frontend directories, navigate to each of these directories and run npm i to install dependencies
  3. Create a new branch for your changes (ex: feat/new-button, fix/refresh-bug, chore/cleanup)
  4. Use conventional commit messages
  5. Open a pull request to suggest your changes

Project Structure

This repository contains two root directories: frontend, and backend:

  • The frontend directory contains all source files relating to the frontend of the application, including the client
  • The backend directory contains all source files relating to the backend of the application, including the database and API

Each of these root directories are their own node.js package, and have different steps for testing and deployment. See the README's of each for more information.

Each of these directories may also contain the following additional sub-directories:

  • node_modules contains the dependencies for said portion of the project. This folder is included in the project's gitignore, and should not be committed to source control
  • dist contains compiled source files ready to be deployed to production

Starting the project

See the README's in the frontend and backend directories for more information on starting each of these.

Team Members

Project Lead - Casey Bartush

Hello, I'm Casey! I'm an undergraduate Computer Science student who's been programming for nearly 10 years. I started with the Python programming language, and I'm currently proficient in other languages such as TypeScript, Java, C++, and Rust. My technological interests include databases, distributed computing, and cybersecurity.

Deputy Lead - Tasha Furey

Hello, I am Tasha! I'm an undergraduate Computer Science student. I am proficient in many languages including java, Python, C#, and SQL. I am currently intrested in learning more about cloud software, machine learning and big data.

Developer - Genyuan Liao

Been programming for about 5 years.

Developer - Huanhuan Cheng

I am Huanhuan Cheng, a graduate student who enjoys cooking and crafting. While my primary expertise lies in Java, I am currently expanding my knowledge on Python and JavaScript. Additionally, I have dabbled in MERN stack a bit. I’m open to learning new languages.

Developer - Rey Balmaceda

Hi, I'm Rey. I feel comfortable working with Java, Python, and JavaScript. I'm open to picking up any other languages should that be necessary. I've been programming (poorly) for about 4 or 5 years now. Other than programming my main hobbies are reading, playing chess (extremely poorly), and games.

Developer - Shwetha Lokesh

My name is Shwetha Lokesh. I'm a senior at Eastern Michigan. And am majoring in computer science I'm graduating next semester. I like Python and JS in other classes but am pretty much fresh in most languages. Thank you.