Skip to content

Latest commit

 

History

History
133 lines (93 loc) · 7.72 KB

README.md

File metadata and controls

133 lines (93 loc) · 7.72 KB
Raw

This project is a full-stack application built with Go (backend) and React (frontend). It uses MongoDB as the database and Tailwind CSS for styling.

Deployed Link -> https://react-golang-todo-production.up.railway.app/

Table of Contents

Prerequisites

Before you begin, ensure you have the following installed on your machine:

Installation

  1. Clone the repository:

    git clone https://github.com/rishyym0927/golang-react-1.git
cd golang-react-1

  2. Install backend dependencies:

    go mod tidy

  3. Install frontend dependencies:

    cd client
npm install

Running the Project

Backend

  1. Set up environment variables:

    Create a .env file in the root directory and add the following:

    PORT=3000
MONGO_URI=your_mongodb_uri
ENV=development

  2. Run the backend server:

    go run main.go

Frontend

  1. Navigate to the client directory:

    cd client

  2. Start the frontend development server:

    npm run dev

  3. Open your browser and navigate to:

    http://localhost:5173

Project Structure

golang-react-1/
├── .env
├── .gitignore
├── .gitignore-1
├── air.toml
├── go.mod
├── go.sum
├── main.go
├── client/
│   ├── index.html
│   ├── src/
│   │   ├── App.jsx
│   │   ├── index.css
│   │   ├── main.jsx
│   │   └── TodoManager.jsx
│   ├── tailwind.config.js
│   └── .env

Environment Variables

The project uses the following environment variables:

  • PORT: The port on which the backend server will run.
  • MONGO_URI: The URI for connecting to MongoDB.
  • ENV: The environment in which the application is running (e.g., development, production).

Available Scripts

Backend

  • go run main.go: Runs the backend server.

Frontend

  • npm run dev: Starts the frontend development server.
  • npm run build: Builds the frontend for production.
  • npm run serve: Serves the built frontend.

Notes

  • Ensure MongoDB is running and accessible via the MONGO_URI specified in the .env file.
  • The backend server runs on http://localhost:3000 by default.
  • The frontend development server runs on http://localhost:5173 by default.

Feel free to contribute to this project by submitting issues or pull requests. Enjoy coding!