https://github.com/alejandroq12/full-stack-api
https://github.com/alejandroq12/full-stack-api
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/alejandroq12/full-stack-api
- Owner: Alejandroq12
- Created: 2023-01-30T18:18:09.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-10T09:08:06.000Z (about 2 years ago)
- Last Synced: 2025-04-04T05:51:11.846Z (26 days ago)
- Language: JavaScript
- Size: 309 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Development and Documentation Final Project
## Trivia App
A bunch of team members got the idea to hold trivia on a regular basis and created a webpage to manage the trivia app and play the game, but their API experience is limited and still needs to be built out.
That's where I come in! Help them finish the trivia app so they can start holding trivia and seeing who's the most knowledgeable of the bunch. The application must:
1. Display questions - both all questions and by category. Questions should show the question, category and difficulty rating by default and can show/hide the answer.
2. Delete questions.
3. Add questions and require that they include question and answer text.
4. Search for questions based on a text query string.
5. Play the quiz game, randomizing either all questions or within a specific category.
Completing this trivia app will give me the ability to structure plan, implement, and test an API - skills essential for enabling your future applications to communicate with others.
## About the Stack
### Backend
The [backend](./backend/README.md) directory contains a partially completed Flask and SQLAlchemy server. I will work primarily in `__init__.py` to define my endpoints and can reference models.py for DB and SQLAlchemy setup. These are the files I'd want to edit in the backend:
1. `backend/flaskr/__init__.py`
2. `backend/test_flaskr.py`
> View the [Backend README](./backend/README.md) for more details.
### Frontend
The [frontend](./frontend/README.md) directory contains a complete React frontend to consume the data from the Flask server.
1. What are the end points and HTTP methods the frontend is expecting to consume?
2. How are the requests from the frontend formatted? Are they expecting certain parameters or payloads?
I must pay special attention to what data the frontend is expecting from each API response to help guide how to format my API specially here:
1. `frontend/src/components/QuestionView.js`
2. `frontend/src/components/FormView.js`
3. `frontend/src/components/QuizView.js`
> View the [Frontend README](./frontend/README.md) for more details.
Microverse README Template
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
> Describe your project in 1 or 2 sentences.
**[your_project__name]** is a...
> Describe the tech stack and include only the relevant sections that apply to your project.
Client
Server
Database
> Describe between 1-3 key features of the application.
- **[key_feature_1]**
- **[key_feature_2]**
- **[key_feature_3]**
> Add a link to your deployed project.
- [Live Demo Link](https://yourdeployedapplicationlink.com)
> Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
### Setup
Clone this repository to your desired folder:
### Install
Install this project with:
### Usage
To run the project, execute the following command:
### Run tests
To run tests, run the following command:
### Deployment
You can deploy this project using:
> Mention all of the collaborators of this project.
👤 **Author1**
- GitHub: [@githubhandle](https://github.com/githubhandle)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
👤 **Author2**
- GitHub: [@githubhandle](https://github.com/githubhandle)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
> Describe 1 - 3 features you will add to the project.
- [ ] **[new_feature_1]**
- [ ] **[new_feature_2]**
- [ ] **[new_feature_3]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> Write a message to encourage readers to support your project
If you like this project...
> Give credit to everyone who inspired your codebase.
I would like to thank...
> Add at least 2 questions new developers would ask when they decide to use your project.
- **[Question_1]**
- [Answer_1]
- **[Question_2]**
- [Answer_2]
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._