Quick Start Guide

Prerequisites

Before you can get started with ShipFast, ensure you have the following prerequisites installed:

1. Node.js (v18.17 or higher)

   Node.js is required to run the project. It comes with npm (Node Package Manager) by default, which will be used to install dependencies. To install Node.js, visit the Node.js download page (opens in a new tab) and choose the appropriate version for your operating system. Make sure you're using Node.js version 18.17 or higher.

Installation

Follow the steps below to set up the project and start using it.

1. Download/Clone ShipFast

2. Install Dependencies

    npm install

3. Configure Firebase, Stripe, and Mailgun (2 mins)

   In order to run ShipFast you'll have to configure Firebase. The other services are optional. Detailed instructions can be found in the Installation Guide:

   • Firebase (Required): Set up Firebase for authentication and other services.
   • Stripe (Optional): Configure Stripe for payment processing.
   • Mailgun (Optional): Transactional emails e.g. signups, billing etc...

4. Start the Development Server

   npm run dev

   Your application should now be running locally. You can open your browser and navigate to http://localhost:3000 to view it.