Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pranjalwalia/nodejs-file-upload-starter
https://github.com/pranjalwalia/nodejs-file-upload-starter
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/pranjalwalia/nodejs-file-upload-starter
- Owner: pranjalwalia
- License: mit
- Created: 2021-06-28T06:30:49.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-06-28T08:11:10.000Z (over 3 years ago)
- Last Synced: 2024-04-11T15:42:11.261Z (10 months ago)
- Language: JavaScript
- Size: 43.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
A barebones hackathon starter to easily integrate Scalable file upload capabilities into your favourite nodejs applications wihtout any refactoring.
# Installation Guide
This project requires the following tools:
- [Node.js](https://nodejs.org/en/) - The JavaScript environment for server-side code.
- [NPM](https://www.npmjs.com/) - A Node.js package manager used to install dependencies.
- [MongoDB](https://www.mongodb.com/) - A NoSQL database system.
# Getting Started
**Step 1. Clone the code into a fresh folder**
```
$ git clone [email protected]:masterchief01/nodejs-file-upload-starter.git
$ cd nodejs-file-upload-starter
```
**Step 2. Install Dependencies.**
Next, we need to install the project dependencies, which are listed in `package.json`.
```
$ npm install
```
or if you're using `yarn`
```
$ yarn
```
**Step 4: Update environment variables and run the Server.**
Create a new file named `.env` by duplicating `.env.example`. Update the new file with the GitHub credentials. It should look similar to this:
```
# .env
MONGO_URL=[INSERT_DATABASE_URL]
PORT=[PORT_TO_RUN_SERVER]
```
Now we're ready to start our server in development mode with:
```
$ npm run dev
```
or if you're using `yarn`
```
$ yarn dev
```
Open http://localhost:5000 to view it in your browser.
The app will automatically reload if you make changes to the code.
You will see the build errors and warnings in the console.
# What's Included ?
- [multer](https://github.com/expressjs/multer): Out of the box suppport for file uploads
- [Express](https://github.com/expressjs/express): A minimalistic web framework
- [mongoose](https://mongoosejs.com/): An ODM for integrating MongoDB in JavaScript Applications
For further steps view the [user guide][user-guide].
# License
This Starter is open source software [licensed as MIT][license].
[user-guide]: https://github.com/masterchief01/nodejs-file-upload-starter/blob/master/docs/CONDUCT.md
[license]: https://github.com/masterchief01/nodejs-file-upload-starter/blob/master/LICENSE