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

#1 Set up project #5

Merged
merged 1 commit into from
Jun 5, 2024
Merged

#1 Set up project #5

merged 1 commit into from
Jun 5, 2024

Conversation

jkarenzi
Copy link
Owner

@jkarenzi jkarenzi commented Jun 5, 2024

what does this PR do?

  • This PR setups the project by creating project structure, installing necessary dependencies, and handling various configurations

Description of the task to be completed

  • Set up empty express project, with basic dependencies
  • Set up CI/CD
  • Set up test environment using jest & code coverage
  • Set up swagger documentation for the project
  • Set up global error handler
  • Write comprehensive README file for project

How can this be manually tested?

  • By accessing the swagger doc route (api-docs)
  • By accessing the api/test route to check if a json response is returned
  • By running npm test:ci to run tests, and check if test setup was done correctly

What are the relevant pivotal trackers/story id?

@jkarenzi jkarenzi added the chore chore label Jun 5, 2024
@jkarenzi jkarenzi added this to the Sprint 1 milestone Jun 5, 2024
@jkarenzi jkarenzi self-assigned this Jun 5, 2024
Copy link

codecov bot commented Jun 5, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@jkarenzi jkarenzi force-pushed the ch-project-setup-#1 branch from 7c87fa1 to 2a2bdd8 Compare June 5, 2024 15:44
-create empty express project
-set up test env
-set up swagger documentation
-set up CI/CD
-set up global error handler
-write comprehensive README
-set up docker

[Finishes #1]
@jkarenzi jkarenzi force-pushed the ch-project-setup-#1 branch from 2a2bdd8 to d4845bb Compare June 5, 2024 15:53
@jkarenzi jkarenzi linked an issue Jun 5, 2024 that may be closed by this pull request
7 tasks
@jkarenzi jkarenzi merged commit 30b434c into develop Jun 5, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore chore
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Chore: Project setup
1 participant