Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ssekpius/microverse-javascript-mealdb

Last synced: 19 days ago
JSON representation

Host: GitHub
URL: https://github.com/ssekpius/microverse-javascript-mealdb
Owner: SSEKPIUS
License: mit
Created: 2022-12-05T11:31:51.000Z (almost 2 years ago)
Default Branch: Development
Last Pushed: 2023-04-07T20:45:26.000Z (over 1 year ago)
Last Synced: 2024-10-03T11:43:16.779Z (about 1 month ago)
Language: JavaScript
Size: 1.87 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Microverse-WebPack-Template

Git/GitHub flow, webpack, linters, and workflows.

 



  

  


  
JavaScript capstone project




# 📗 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](#faq)

- [📝 License](#license)

# 📖 [your_project_name] 

> Describe your project in 1 or 2 sentences.

**[TheMealDB]** The JavaScript capstone project is about building our own web application based on an external API. You will select an API that provides data about a topic that we like and then build the web app around it. The web app will have 2 or 3 user interfaces (depending on the size of your team):

## 🛠 Built With 

### Tech Stack 

> PEN Stack (PostgreSQL, Express.js, Node.js)

  Client

  


    Node.js

  


  Server

  


    Express.js

  


Database

  


    PostgreSQL

  


### Key Features 

> Features of the application.

- **[list_food_list]**

- **[like_food_item]**

- **[comment_food_item]**

(back to top)


## 🚀 Live Demo 

> Add a link to your deployed project.

- [Live Demo Link](https://ssekpius.github.io/Microverse-JavaScript-group-capstone-set-up-your-Kanban-board/dist/)

(back to top)


## 💻 Getting Started 

> How a you could make use of this project.

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need these, incase they are not already setup, Kindly Read [Prerequisites](./Prerequisites.md).

### Setup

Clone this repository to your desired folder:

```sh

  mkdir my-folder

  cd my-folder

  git clone https://github.com/SSEKPIUS/Microverse-JavaScript-group-capstone-set-up-your-Kanban-board.git 

```

### Install

Install this project with:

```sh

  npm install -force

```

### Usage

To run the project, execute the following command:

Example command:

```sh

  npm run start

```

### Run tests

To run tests, run the following command:

Example command:

```sh

  npm test

```

### Deployment

You can deploy this project using:

(back to top)


## 👥 Authors 

> Mention all of the collaborators of this project.

👤 **Author 1**

1. Ssekweyama Pius

- GitHub: [@githubhandle](https://github.com/SSEKPIUS)

- Twitter: [@twitterhandle](https://twitter.com/SSEK_PIUS)

- LinkedIn: [LinkedIn](https://linkedin.com/in/pius-ssekweyama-23665794)

👤 **Author 2**

1. Precious Nhlapho

 

- GitHub: [@githubhandle](https://github.com/Ambient567) 

- Twitter: [@twitterhandle](https://twitter.com/Ambient567)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/precious-nhlapho-8b8b4a246/)

(back to top)


## 🔭 Future Features 

> Features you we will add to the project.

- [ ] **[Reservations]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

> We encourage you to support this project

If you like this project, kindly donate a token at [Paypal]()

(back to top)


## 🙏 Acknowledgments 

> Credit to everyone who inspired this codebase.

I would like to thank microverse student team for the resorces availed.

(back to top)


## ❓ FAQ 

> Questions new developers would ask when they decide to use this project.

- **What is front-end, HTML, CSS and JavaScript**

  - The front end refers to the parts of the application that users (also known as "clients") interact with directly

  - As a front-end dev, you'll implement these tasks primarily using HTML to define the structure of web pages, CSS to add styling, and JavaScript to add interactivity.

- **What is back-end and Full stack**

  - The back end refers to the parts of the application that run behind the scenes and aren't presented directly to the user/client.

  - The back end typically includes a web server which handles HTTP connections received from the front-end client (usually a web browser)

  - Full stack simply includes both the front end AND back end!

(back to top)


## 📝 License 

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._

(back to top)