This repository contains a Next.js application that you can run locally or deploy to a server. Follow the instructions below to get started.
Make sure you have the following software installed on your machine:
- Node.js (version 12 or above)
- npm (Node Package Manager) or yarn
-
Clone this repository to your local machine using the following command:
git clone https://github.com/Kashish-max/Landing-Page.git
-
Navigate to the project directory:
cd Scribble-Docs/ -
Navigate to the frontend folder and Install the dependencies using either npm or yarn:
# Using npm npm install # Using yarn yarn
-
Navigate to the backend folder and Install the dependencies using either npm or yarn:
# Using npm npm install # Using yarn yarn
-
Setup environment variables(.env file) in root directory of backend:
DB_USERNAME=<DB_USERNAME> DB_PASSWORD=<DB_PASSWORD> NODE_ENV=<development> JWT_SECRET=<ANY_SECRET_KEY> COOKIE_KEY=<ANY_SECRET_KEY> GOOGLE_CLIENT_ID= GOOGLE_CLIENT_SECRET= GOOGLE_CALLBACK_URL=
-
Create Google OAuth Client Id on Google Cloud Console and Add the required credentials in environment variables
Once you have installed the dependencies, you can run the Next.js app on your local machine. Follow these steps:
-
Start the development server on both frontend and backend:
# Using npm npm run dev # Using yarn yarn dev
-
Open your web browser and visit
http://localhost:3000to see the app in action. -
You can make api requests to
http://localhost:9000to see the app in action.
The app can be deployed to a server or cloud platform of your choice. Here are some deployment options:
Refer to the respective documentation of the deployment platform for detailed instructions on how to deploy a Next.js app.
You can find the deployed version of the website at the following link:
A video demonstration of the website can be found at the following link: