Skip to main content

Installion

Here, we will introduce you to the basic installation steps for OneDay.Build. As long as you follow the steps one by one, you can set up a basic SaaS platform locally in about One Day.

1. Getting the code​

First, you need to get the code package for this SaaS Kit from GitHub. There are two ways to get the software package:

  • Login to https://github.com/slashui/OneDayBuildKit with the GitHub account you used to purchase OneDay.Build. Then, click the ⭐ icon in the top right corner . find the Code button, and download the zip file. If the login account is different from the oneday.build you filled out before, you will not be able to access this link.

  • Use the git command to download it. In the terminal, navigate to the appropriate folder, and then enter the following command:

git clone https://github.com/slashui/OneDayBuildKit.git

2. Installation and Startup​

1. Navigate to the downloaded folder​

cd OneDay.Build

2. Install Dependencies​

Check the versions of the dependencies in the root directory by finding package.json.

npm install
info

You need to pay attention to your Node.js version. I developed this based on Node v18.19.0, so I hope your environment is at least not lower than this version.

3. Make .env File​

This is a local configuration file that records all the API information of third-party applications that your SaaS platform needs to connect with. This file is very important and directly affects whether your platform can perform the corresponding functions. You don't need to create this file yourself; I have prepared it for you. In the root directory, you will find a file named .env.example, rename it to .env.

4. Start the Platform​

If everything goes smoothly, you can now start your platform. (The whole process may take less than 5 minutes)

npm run dev

No errors? Congratulations, your platform is now running in your local environment. You need to quickly open your browser and type http://localhost:3000/ in the address bar.

That's how simple the initial installation is. If you encounter any problems, you can mail to me, where we will answer your questions.