Skip to content

Latest commit

 

History

History
91 lines (74 loc) · 4.55 KB

SETUP.md

File metadata and controls

91 lines (74 loc) · 4.55 KB
Raw

StockedUp Setup Guide

Welcome to the setup guide! This document will guide you through the process of running StockedUp by yourself. If you want to actually check out StockedUp, I would recommend the live demo.

This guide will help you to:

  • Setup a local development environment to contribute to the project.
  • Create a self-hosted StockedUp instance on your computer.
  • Setup a self-hosted StockedUp instance on any cloud service.

Prerequisites

Before proceeding any further, you'll need to configure a couple of external services that StockedUp uses. We use Resend to send transactional emails. We also use AWS S3 for hosting attachments and profile pictures.

Resend

To send transactional emails, we use Resend. Please follow this guide to configure a domain and obtain a Resend API key.

  1. Create a Resend account.
  2. Configure a Domain that will be used to send emails.
  3. Generate an API Key. Please select Sending Access under Permissions and correct the Domain.
  4. Save this API key for later configuration.

Amazon AWS S3 Bucket

To store product images as well as user avatars, we use Amazon Web Services S3 Bucket. StockedUp usage falls under AWS Free Tier. Creating an AWS account will start a 12-month Free Tier period. Please follow this guide to create an S3 bucket and obtain credentials.

  1. Create an AWS account.
  2. Create a new S3 bucket. You can choose any name and any region. We don't require ACLs to be enabled.
  3. Create a new IAM user.
  4. Add a new policy to this user. The easiest way is to use an inline policy.
    • Navigate to the created user and find the Permissions policies section. Click Add permissions -> Create inline policy.
    • Allow for: List -> ListBucket, Read -> GetObject, Write -> DeleteObject, Write -> PutObject.
    • Allow for resources: arn:aws:s3:::[YOUR BUCKET NAME]/*, arn:aws:s3:::[YOUR BUCKET NAME].
    • Save this policy under the name of your choice.
  5. Create a new Access key for your user.
    • Navigate to the created user and select the Security Credentials tab.
    • Click Create Access Key.
    • Select Other and click Next.
    • Choose any name.
    • Click Create access key.
  6. Save the Access key and Secret access key for later configuration.

Setup

Depending on your needs, you can deploy StockedUp locally or using a Docker container. If you wish to make this setup permanent, deploy using containers. If you want to contribute to this project, set it up manually.

Docker Setup

We have also configured Docker for simpler deployments on web servers.

  1. Clone this repository: 
    git clone https://github.com/MrBartusek/stocked-up.git
cd stocked-up
  2. Copy the .env.example file and rename it to .env. Fill this configuration file with your API keys and other configuration options. For reference, see the configuration guide.
  3. Run the project with compose 
    docker-compose -f docker-compose.yaml -f docker-compose.prod.yaml up -d

Local Setup

Set up StockedUp by manually configuring Node.js, Redis, and MongoDB. You can also call this approach Bare Metal.

Make sure you have installed and working on your system:

  • Latest Node.js LTS release.
  • Running Redis server. (I would recommend using WSL if you are on Windows).
  • Running MongoDB server.
  1. Clone this repository: 
    git clone https://github.com/MrBartusek/stocked-up.git
cd stocked-up
  2. Install dependencies using NPM 
    npm i
  3. Copy the .env.example file and rename it to .env. Fill this configuration file with your API keys and other configuration options. For reference, see the configuration guide.
  4. Run the project using npm run dev in watch mode.

You may also wish to build this project and serve it in production mode. To do this, follow this guide:

  1. Change the following options in .env:
    • set NODE_ENV to production
    • set BASE_API_URL to your API URL (http://localhost:3000/api for local builds)
  2. Build the project 
    npm run build
  3. Start the project 
    npm run start