Frontend & Backend Installation Guide
Installation guide for my frontend and backend applications.
Frontend Installation Guide
To set up the frontend application, follow these instructions to get your Next.js app running locally.
Prerequisites
Ensure you have the following installed on your machine:
- Node.js (LTS version recommended) installed on your machine
Remember:
Make sure to install the correct Node.js version to avoid compatibility issues.
Installation Steps
-
Clone the Repository: Clone the frontend repository to your local machine.
git clone https://github.com/digitalterrene/frontend-project.git
-
Navigate to the Project Directory: Move into the project folder.
cd frontend-project
-
Install Dependencies: Use npm or yarn to install the required dependencies.
npm install # or yarn install
-
Start the Application: Launch the application in development mode.
npm run dev # or yarn dev
-
Open in Browser: Open your web browser and navigate to
http://localhost:3000
to view the application.
Backend Installation Guide
Below is the installation guide for setting up the backend Node.js API.
Prerequisites
Before starting, confirm you have:
- Node.js (LTS version recommended) installed on your machine
- Git
- MongoDB (if using a local MongoDB database)
Remember:
Be sure to configure your environment variables properly to connect to your database and other services.
Installation Steps
-
Clone the Repository: Clone the backend repository to your local machine.
git clone https://github.com/digitalterrene/backend-project.git
-
Navigate to the Project Directory: Move into the project folder.
cd cd backend-project
-
Install Dependencies: Install the necessary dependencies with npm or yarn.
npm install # or yarn install
-
Set Environment Variables: Create a
.env
file in the root directory, and configure your database URI and other necessary environment variables.PORT=5000 DATABASE_URI=mongodb://localhost:27017/your-database
-
Start the Server: Run the server in development mode.
npm start # or yarn dev
-
Test the API: Your API should now be live at
http://localhost:5000
. Use an API client (e.g., Postman) to test your endpoints.