Skip to main content

✏️ Building An API Independent Project

Independent Projects Overview​

Project prompts will be available on Epicenter at 8:00 am Friday for full-time students and 8:00 am on Thursday for part-time students. Before you begin your project, make sure to take a moment to review the Independent Projects and Code Reviews lesson.

Building an API Project Objectives​

Your code will be reviewed for the following objectives:

  • Application includes CRUD functionality and successfully returns responses to API calls.
  • README thoroughly describes all endpoints along with parameters that can be used.
  • Application includes a best effort at implementing at least one of the further exploration objectives: authentication, versioning, pagination, or CORS.
  • README includes specific documentation on further exploration: what it is and how to use it.
  • Build files and sensitive information are included in .gitignore file and is not to be tracked by Git, and includes instructions on how to create the appsettings.json and set up the project.
  • Project is in a polished, portfolio-quality state.
  • The prompt’s required functionality and baseline project requirements are in place by the deadline.

Implementing a Further Exploration Objective​

We are looking for your best effort in implementing a further exploration objective. Why? Some are more challenging than others, like authentication. We want to encourage you to challenge yourself for this project and not feel the pressure of needing to successfully complete an objective to simply pass. With the time you have in class to work on further exploration and the skills you have at the end of this course, we generally expect to see that most students complete this objective.

Your teacher will review your README and your commit history to understand your progress on implementing a further exploration objective. If you do not complete a further exploration objective, make sure that your project documentation reflects this. We recommend updating the "Known Bugs" section of your README, but you may find a better location to relay this information.

What is a polished, portfolio-quality state?​

When a project is both polished and in a portfolio-quality state, this means:

  • You've reviewed your project and your README prior to submitting it to make sure there are no errors or missing information and you are consistent in your indentation, spacing, and code structure.
  • You are following the best practices and coding conventions we teach.

What are the baseline project requirements?​

All independent coding projects at Epicodus have these baseline requirements:

  • A complete and informative README
  • The project's commit history demonstrates that the project’s required work schedule and hours have been met:
    • 8 hours completed on Friday is required for full-time students
    • 4 hours completed over the weekend is required for part-time students
  • Completion of the project based on the prompt and objectives. The prompt contains details on the project's theme and features that are not always detailed in the objective. Carefully read through the prompt towards the end of your work session to make sure that you are not missing anything.

Submission​

Submit your Github repository to the Building an API Code Review on Epicenter.

Visit Independent Projects and Code Reviews for details on how to submit your code, how feedback works and course completion requirements.