Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/inglorious-ratbastard/star_wars_movie_app

Rebel Base Movies | Star Wars Episode Guide | ExpressJS SPA
https://github.com/inglorious-ratbastard/star_wars_movie_app

bootstrap ejs-express herokuapp jquery node-js single-page-app

Last synced: 10 days ago
JSON representation

Rebel Base Movies | Star Wars Episode Guide | ExpressJS SPA

Awesome Lists containing this project

README 

        
### Rebel Base Movies - Star Wars Episode Browser

##### A Star Wars Movie Episode Guide (Ep 1-6)

##### ExpressJS Single Page Application (SPA) 
 deployed on [Render](https://render.com/) Cloud Hosting Services

___

#### [Live Application](https://rebel-base-movies.onrender.com/)

##### Single Page Web Application 

![Node](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)

![Express](https://img.shields.io/badge/Express.js-404D59?style=for-the-badge)

![Render](https://img.shields.io/badge/Render-%46E3B7.svg?style=for-the-badge&logo=render&logoColor=white)


![Bootstrap](https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white)

![JQuery](https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white)

![CSS](https://img.shields.io/badge/CSS-239120?&style=for-the-badge&logo=css3&logoColor=white)

___

#### About This Application:

A simple single page interface that displays various movie information about Episodes 1-6

with stunning image posters, character info, and plotline synopsis. 

___

#### Dependencies:

[NodeJS](https://nodejs.org/en/docs/)


[ExpressJS](https://expressjs.com/en/4x/api.html)


[Bootstrap](https://getbootstrap.com/docs/5.2/getting-started/introduction/)


[jQuery](https://api.jquery.com/)


[Render](https://render.com/docs)

___

#### **Getting Started:** 

##### Before proceeding with the following steps it is assumed that both [Node.js](https://nodejs.org/en/download/) and [Git](https://git-scm.com/downloads) have been downloaded locally on your system. 
 If not, they can be obtained by clicking on the links provided. Further assistance can be found in the documentation if necessary. 

1. **Clone** this repository `$ git clone https://github.com/inglorious-ratbastard/star_wars_movie_app.git`

2. In the terminal/command prompt run the `npm install` or `yarn install` command to install the projects dependencies

3. Run the `node app.js` command in the terminal to start the server and run the application

___

#### Deployment to Render:

##### Note: Previous deployment to Heroku is reflected in the original code base. This has been changed due to the lack of free-hosting tiers provided. 
 Current deployment has been moved to Render Cloud Services. A brief explanation of how to do this is provided below. 



* Assure that your project has successfully been committed to Github. Any future changes made and pushed up will be directly reflected on [Render](https://render.com/). 

* From the Dashboard click on **New** to connect your Github repo and create your hosted application from the given options (either Static Site or Web Service). 

* Name your projet then scroll down and make sure that the `yarn build` and `yarn start` point to the correct files. *See the Scripts section of `package.json` file for clarification.*

* If you have any global or secret keys you can create them by expanding the **Advanced** tab and manually entering the proper values in the form boxes provided.

___

#### **Reporting Bugs or Issues:**

 If you would like to report a **Bug** or **Issue** in this repo feel free to do so under the **Issues** tab or contact me directly about any major concerns. Ideas for improvements or enhancements to this project are also encouraged. Please address these matters by sending a **Pull Request** as they will be reviewed for potential consideration. 

___

#### Contributing:

* **Clone** this repository and create a new branch:


  `$ git clone https://github.com/inglorious-ratbastard/star_wars_movie_app.git -b name_of_new_branch`

* Introduce a new feature, fix an existing bug, or clean up current code 

* Throroughly **Test** the changes that have been implemented [Testing suite is not included]


some suggestions for testing: [Cypress](https://www.cypress.io/), [Jasmine](https://jasmine.github.io/), [Mocha](https://mochajs.org/) 

* Submit a **Pull Request** accurately explaining the changes that were made to this repository

##### Your contribution will be reviewed and considered for merge into Main or a separate branch.
 Thank you for assisting in the development and/or advancement of this project.

___