Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code setup #2

Merged
merged 10 commits into from
Nov 27, 2023
Merged

Code setup #2

merged 10 commits into from
Nov 27, 2023

Conversation

benjaminJohnson2204
Copy link
Collaborator

Changes

I set up the code in the repository to allow developers to begin running the project and adding features. I added:

  • NextJS project from create-next-app for frontend
  • Node & Express.js server with MongoDB connection for backend
  • Environment variable definitions for both frontend and backend, with example .env files
  • Firebase SDKs and configuration for both frontend and backend, and a Firebase project
  • A development Gmail account and app password, allowing us to send emails from our backend using nodemailer package
  • Unit tests using Jest for both frontend and backend
  • Linter & formatter using ESLint & Prettier, run on every commit using Husky
  • GitHub Actions workflows to run lint and formatting checks, compilation, and unit tests on every PR to main branch
  • README.md updated with instructions to run the project

Testing

  • I ran the project on Ubuntu, Mac, and Windows, and verified that it worked on all three. I also tested that various features (e.g. Firebase auth, sending emails, MongoDB connection) worked by creating simple test programs.

Confirmation of Change

  • Run the project using the environment variables in the TSE Google Drive, and you should be able to see that everything (running, lint and formatting checks, building, unit tests) works correctly.

@benjaminJohnson2204 benjaminJohnson2204 merged commit a9913e4 into main Nov 27, 2023
4 checks passed
@benjaminJohnson2204 benjaminJohnson2204 deleted the code-setup branch November 27, 2023 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant