From 4c6ec0820437c156ce10c9450bee9db2c7ea28a6 Mon Sep 17 00:00:00 2001 From: Rahul Yadav Date: Fri, 11 Oct 2024 03:59:23 +0530 Subject: [PATCH] docs(readme): add local setup instructions --- .env.example | 3 +++ README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) diff --git a/.env.example b/.env.example index c549db6..a547683 100644 --- a/.env.example +++ b/.env.example @@ -1,2 +1,5 @@ RECOIL_DUPLICATE_ATOM_KEY_CHECKING_ENABLED=false NEXT_PUBLIC_DISABLE_WEBCONTAINER=false + +# https://proxy.cors.sh/ +NEXT_PUBLIC_PROXY_KEY= diff --git a/README.md b/README.md index 57b0789..dda8a64 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,53 @@ We are pleased to announce that our project is now live, and you can access it a ![IDE Preview](/images/screenshot.jpg) +## Local Setup + +To set up the project locally for development with **Node.js 18 LTS** or higher, follow these steps: + +### Steps + +1. **Clone the repository** +2. **Install the dependencies**: After cloning the repository, navigate to the project directory and install the dependencies: + + ```bash + npm install + ``` + +3. **Run the development server**: + + ```bash + npm run dev + ``` + +4. **Open the project in the browser**: Once the development server is running, open your browser and navigate to: + + ``` + http://localhost:3000 + ``` + + This will load the local version of the IDE. + +Ensure that you configure any necessary environment variables in a `.env.local` file. You can create this file by copying `.env.example` and modifying it with your own values. + +```bash +cp .env.example .env.local +``` + +### Building for Production + +To create an optimized production build of the application, use the following command: + +```bash +npm run build +``` + +After the build process is complete, you can start the production server: + +```bash +npm start +``` + ## 📖 Documentation The documentation for Nujan can be found at [docs.nujan.io](https://docs.nujan.io/)