Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/inglorious-ratbastard/cleaning-services-site

Professional Cleaning Services - Materialize UI/UX - ExpressJS App
https://github.com/inglorious-ratbastard/cleaning-services-site

bodyparser express express-js material-design materializecss nodemailer

Last synced: about 2 months ago
JSON representation

Professional Cleaning Services - Materialize UI/UX - ExpressJS App

Awesome Lists containing this project

README 

        
### Cleaning Services Site

___

###### **Professional Cleaning Services Co.**

###### **Entrepreneurial Web Application** 

###### **Materialize UI/UX - ExpressJS App** 


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

![Express](https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express&logoColor=white)

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


![Materialice CSS](https://img.shields.io/badge/material%20design-757575?style=for-the-badge&logo=material%20design&logoColor=white)

![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)

___

#### **About this Build:**

##### **This application was built with simplicity in mind, along with compelling visual synergy that compliments the user interface** 

##### **Customized Features:**

* ##### *Lightweight build using ExpressJS and styled with Materialize CSS*

* ##### *Aesthetically designed layout including call-to-action pagination* 

* ##### *Static floating Contact menu button - creates readily accessible connection to interaction with company*

* ##### *Form submission using Nodemailer - sends user submitted content directly to connected email address* 

---

#### **Build Tools:**

##### **This project uses the following packages:**

##### [ExpressJS](https://expressjs.com/)

##### [Materialize CSS](https://materializecss.com/) 

##### [Nodemailer](https://nodemailer.com/about/)

##### [body-parser](https://www.npmjs.com/package/body-parser)

___ 

#### **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/cleaning-services-site.git`

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

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

___

#### Deployment to Render:

##### About: The following explains how this app was deployed to [Render](https://render.com/) Cloud Hosting, assuming that you have already set up an account. Another preferred option for hosting services would be [Railway](https://railway.app/)

#### * Assure that your project has successfully been committed to Github. Any future changes made and pushed up will be directly reflected on **Render**. 

#### * 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/cleaning-services-site.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.

___