Giter VIP home page Giter VIP logo

node-upload-example's Introduction

๐Ÿ“ท node-upload-example

Minimal application developed with Node.js and TypeScript used to upload images to Amazon S3

Tech

  • Node.js - Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine
  • TypeScript - TypeScript is a superset of JavaScript that compiles to clean JavaScript output
  • Express - Fast, unopinionated, minimalist web framework for Node.js
  • Amazon S3 - Object storage built to store and retrieve any amount of data from anywhere
  • MongoDB - Document-oriented NoSQL database used for high volume data storage

Getting started

The application supports uploading images to both local storage and Amazon S3. By default it'll be storing the images locally for simplicity, but if you want to test it using S3 you'll need to setup an AWS account.

In order to run the project you'll need to have Node.js and Yarn installed in your machine. The posts are stored on a MongoDB database, so you also need a MongoDB instance configured locally or in the cloud.

# Clone repository
$ git clone https://github.com/danielccunha/node-upload-example.git
$ cd node-upload-example

# Populate environment variables
$ cp .env.example .env
$ nano .env

# Install dependencies
$ yarn

# Start the project in development mode
$ yarn dev

The only required environment variable is the MONGO_URL used to connect to MongoDB. If you want to use Amazon S3 you'll also need to populate the AWS_* variables and change the STORAGE_TYPE to s3.

License

This project is licensed under the MIT License - see the LICENSE file for details.

node-upload-example's People

Contributors

ddanielcruz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.