---

Let our AI tool help you create engaging content that breaks through the noise and gets you seen by the right people.

---

---

Prerequisites

Before you begin setting up the project, ensure you have the following software installed on your machine:

1. Node.js: This is essential for running JavaScript outside the browser. You can download and install the latest version from the official Node.js website.

2. npm (Node Package Manager): npm is installed automatically with Node.js. It allows you to manage and install packages necessary for your project.

3. Git: Git is used for version control. If you don't have it installed, you can download it from the official Git website.

4. MongoDB: MongoDB must be installed according to your operating system. Follow the installation instructions from the official MongoDB website.

5. Postman (optional but recommended): Postman is useful for testing APIs and backend endpoints. You can download it from the official Postman website.

Environment Configuration

Setting up the .env files is crucial for the project. These files store all the necessary environment variables required for the application to run, such as API keys and configuration settings. Follow these steps:

1. Separate .env Files for Frontend and Backend: The project uses two separate .env files, one for the frontend and another for the backend. Make sure to set up both configuration files properly before proceeding with the installation.

2. Copy the Sample Environment Files: The repository includes sample environment files named .env.sample.frontend (in the frontend directory) and .env.sample.backend (in the root directory). Copy these files to create your own .env files.

   cd frontend/ && cp .env.sample.frontend .env
   cd backend/ && cp .env.sample.backend .env

3. Edit the .env Files: Open each .env file in a text editor and replace the placeholder values with your actual API keys and configuration settings. You may need to add multiple API keys depending on the services your project integrates with.

   # Example .env file for backend
   DB_CONNECTION_STRING=your_database_connection_string_here

   Replace your_database_connection_string_here with your actual credentials and configuration value.

4. Run the Installation Scripts: After setting up the .env files in both the frontend and backend directories, run the following bash scripts in separate terminal sessions to install the necessary dependencies:

   ./install-frontend.sh
   ./install-backend.sh

5. All in one Installation Script: After setting up the .env files in both the frontend and backend directories, run the following bash script to install the necessary dependencies and start both the frontend and backend:

   ./install-all.sh

Installation

Follow these steps to set up the project on your local machine:

1. Clone the repository:

   git clone https://github.com/viralxpost/viralxpost-web.git

2. Navigate to the project directory:

   cd viralxpost

3. Make the installation script executable:

   sudo chmod +x install.sh

4. Run the installation script:

   ./install.sh

Available Scripts

In the project directory, you can run:

• npm start : Starts the backend server using nodemon with backend/server.ts.
• npm run dev : Starts the frontend development server from the frontend directory.

Learning Resources

• Reactjs
• Node
• Express
• MongoDB

Need Help?

• Discord
• Twitter
• [email protected]

Top Contributors