Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mister-fix/cisc3140_lab5

CISC3140 Lab 5 is a fullstack web application built with Node/Express, SQLite, EJS, and Bootstrap that allows users to view and update data about cars.
https://github.com/mister-fix/cisc3140_lab5

Last synced: 19 days ago
JSON representation

CISC3140 Lab 5 is a fullstack web application built with Node/Express, SQLite, EJS, and Bootstrap that allows users to view and update data about cars.

Host: GitHub
URL: https://github.com/mister-fix/cisc3140_lab5
Owner: mister-fix
License: apache-2.0
Created: 2022-05-09T00:56:39.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-05-13T07:24:53.000Z (over 2 years ago)
Last Synced: 2024-07-15T22:45:56.842Z (5 months ago)
Language: JavaScript
Size: 428 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# **CISC3140 Lab 5**
![Github repo size](https://img.shields.io/github/repo-size/ogre2/cisc3140_lab5)
![Github code size](https://img.shields.io/github/languages/code-size/ogre2/cisc3140_lab5)
![Contributors](https://img.shields.io/static/v1?&label=contributors&message=1&color=red)
![License](https://img.shields.io/static/v1?&label=license&message=Apache%20v2.0&color=blue)
![Node version](https://img.shields.io/static/v1?&label=node&message=v16.15.0&color=success)
![npm version](https://img.shields.io/static/v1?&label=npm&message=v8.8.0&color=orange)
![GitHub stars](https://img.shields.io/github/stars/ogre2/cisc3140_lab5?style=social)

CISC3140 Lab 5 is a fullstack web application built with Node/Express, SQLite, EJS, and Bootstrap
that allows users to view and update data about cars. You can view the app here: [https://cisc3140lab5.herokuapp.com/](https://cisc3140lab5.herokuapp.com/).

## **Prerequisites**

Before you begin, make sure you have met the following prerequisites:

- You have installed `` version 14.15.4 and above.
- You can download the latest LTS version here: https://nodejs.org/en/.
- You have installed `` version 8.8.0 and above.
- You can download the latest version here: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm.
- You have installed the latest version of Git.
- You can download Git here: https://git-scm.com/downloads.

## **Installing CIS3140 Lab 4**

To download the `` API repo, follow the following instrunctions for your OS.

### **1) Using Git** (Recommended)
Run the following command in your terminal/CLI to clone the API repo.
```
git clone https://github.com/ogre2/cisc3140_lab5.git
```

### **2) Windows**
If you're a Windows OS user, you can install the CISC3140 Lab 4 project using Git by following the instrunctions above.
You can also install the project using the **[latest release version](https://github.com/ogre2/cisc3140_lab5/releases)** and downloading the zipped source code folder.

### **3) Linux and MacOS**
If you're a Linux or MacOS user, with the aforementioned prerequisites installed and running on your machine. You can employ the Git method
to install/clone the repo locally on your machine and test the API.

You can also install the project using the **[latest release version](https://github.com/ogre2/cisc3140_lab5/releases)** and downloading the `` folder.
Then in your terminal run the following command to unzip and extract
```
tar -xzf tarfile
```

### **4) Web Browser**
Alternatively, you can view the API on your browser by visiting **[https://cisc3140lab5.herokuapp.com/](https://cisc3140lab5.herokuapp.com/)**.
Note: The API's HTTP requests are limited to `` requests only, this is due to the database solution employed in the API being SQLite.
SQLite is a serverless database solution, and therefor changes to the database done through HTTP requests such as `` or `` cannot work
on the web version. It is recommended that you install and run the project **locally** to take advantage of all created endpoints.

## **Launching/Using API**
1. Using your terminal/CLI, navigate to the **cisc3140_lab4-vX.X.X** folder.
2. Using your terminal/CLI, run the `` command to automatically download all dependencies for the project.
3. Using your terminal/CLI, run the `` command to launch the API server.
1. Your console will log '**server is running on port:4000**', to indicate that the API has launched successfully.
2. Your console will log '**Connected to database...**', to indicate that the API has successfully connected to the database.
4. On your browser, navigate to ``.
5. You should see `<{"message":"Ok"}>`, which will indicate that the API is working.
6. Visit the various API end points at your leisure.
1. View the **[API documentation](https://documenter.getpostman.com/view/15181657/UyrHftTK)** for details on endpoints.

## **Contributing to this project**

To contribute to ``, follow these steps:
- Fork this repository.
- Create a branch: git checkout -b .
- Make your changes and commit them: `>`.
- Push to the original branch: ``.
- Create the pull request.
- View the GitHub documentation on **[creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)**.

## **Known Bugs**

- The `` view does not render.

## **Contributors**

Thanks to the following people who have contributed to building this application:

- [@ogre2](https://github.com/ogre2/) 💪

## **License**

This project uses the following license: [Apache License 2.0](https://github.com/Olivr/app-node-js/blob/main/LICENSE).