Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remrkabledev/node-basics-intro
An introduction to Node.js using a collection of example applications.
https://github.com/remrkabledev/node-basics-intro
ejs-express ejs-templates hbs mongoose nodejs sequelize
Last synced: about 2 months ago
JSON representation
An introduction to Node.js using a collection of example applications.
- Host: GitHub
- URL: https://github.com/remrkabledev/node-basics-intro
- Owner: reMRKableDev
- Created: 2020-03-17T06:46:16.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T20:06:50.000Z (2 months ago)
- Last Synced: 2024-10-20T06:32:28.717Z (2 months ago)
- Topics: ejs-express, ejs-templates, hbs, mongoose, nodejs, sequelize
- Language: JavaScript
- Homepage:
- Size: 53 MB
- Stars: 8
- Watchers: 2
- Forks: 40
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node Basics Intro ๐๐๐
[![CodeFactor](https://www.codefactor.io/repository/github/remrkabledev/node-basics-intro/badge/main)](https://www.codefactor.io/repository/github/remrkabledev/node-basics-intro/overview/main) [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
This repo holds small node projects that introduce concepts, practices and techniques used with Node.js
![node-banner](node-banner.png)
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
What things you need to install the software and how to install them
```
NPM / Yarn
Code Editor (This app was built on VSCode)
Git
```### Installing
To get this project on your local machine, you first need to clone it using the `git clone` command.
```
git clone https://github.com/reMRKableDev/node-basics-intro.git
```Running this on your terminal will ensure you receive the latest version with all it's changes.
Once you've cloned, navigate into your desired project folder and run:
```
npm install
```This should retrieve all the necessary dependencies named in the `package.json` file.
### How To Use:
Once dependencies are installed, each project can be run using:
```
npm start
```## Running tests ๐งช
The testing framework utilized is Jest. Tests can be run by using the command:
```
npm testOR
npm run test
```## Contributing ๐
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note that there is a code of conduct, please follow it in all your interactions with the project.
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
## Authors ๐ป
- **Malcolm R. Kente** - _Initial work_ - [reMRKable Dev](https://remrkabledev.com/)
- **Lloyd Chambrier** - developed `node-api-requests` & `node-omdb-api` repo found in` node-express-api` folder - [LloydC](https://github.com/LloydC)## Acknowledgments ๐ฃ๏ธ
[Node.js](https://nodejs.org/en/)
[Express.js](https://expressjs.com/)
[Handlebars.js](https://handlebarsjs.com/)
[MySQL Node.js JavaScript Client](https://github.com/mysqljs/mysql#readme)