Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fingertips18/go-react-starter
🚀Explore Go (Golang) with hands-on API development and syntax experimentation. Perfect for beginners and devs diving into Go’s core features!
https://github.com/fingertips18/go-react-starter
chakra-ui go golang react-router-dom reactjs starter-project tanstack-react-query typescript
Last synced: 18 days ago
JSON representation
🚀Explore Go (Golang) with hands-on API development and syntax experimentation. Perfect for beginners and devs diving into Go’s core features!
- Host: GitHub
- URL: https://github.com/fingertips18/go-react-starter
- Owner: Fingertips18
- License: mit
- Created: 2024-09-04T17:52:41.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-12-02T15:17:19.000Z (22 days ago)
- Last Synced: 2024-12-02T16:27:47.841Z (22 days ago)
- Topics: chakra-ui, go, golang, react-router-dom, reactjs, starter-project, tanstack-react-query, typescript
- Language: TypeScript
- Homepage: https://go-react-starter.onrender.com
- Size: 1.25 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 Go Starter
This repository serves as a playground for exploring **Go (Golang)** features, including **API development**, **syntax experimentation**, and learning the **basics of Go** programming. Ideal for beginners and developers looking to get hands-on experience with **Go**.
### 🔗 Website Link: [Live](https://go-starter.onrender.com/)
## 📚 Table of Contents
- 🔧 [Technologies Used](#tech-used)
- ✨ [Features](#features)
- 📖 [Setup Instructions](#setup)
- 🚀 [Backend (Go)](#backend)
- ⚛️ [Frontend (React JS)](#frontend)
- 📡 [API Endpoints](#api)
- 🤝 [Contributing](#contributing)
- 📜 [License](#license)
## 🔧 Technologies Used
- **Frontend**: React JS ⚛️
- **Backend**: Go (Golang) 🚀
- **Database**: MongoDB 🗄️
- **UI**: Chakra UI 🏠
- **Query**: Tanstack Query 🌐
## ✨ Features
- **📝 CRUD Operations**: Create, Read, Update, and Delete operations for user and application data.
- **📱 Responsive UI**: Developed using **Chakra UI** components, ensuring a seamless experience across devices.
- **📡 API**: Robust API constructed using **Express.js** and **MongoDB** for seamless data interaction.
## 📖 Setup Instructions
### 🛠️ Backend Go (Golang)
1. **Clone the repository**:
```bash
git clone https://github.com/Fingertips18/go-starter.git
```
2. **Install dependencies**:
```bash
cd go-starter
go mod tidy
```
3. **Set up environment variables. Create a `.env` file in the root directory:**:
```dotenv
MONGO_URI=
PORT=
MODE=
CLIENT_URL=
```
4. **Run the backend server**:
```bash
go run main.go
// or
go install github.com/air-verse/air@latest
air
```
### ⚛️ Frontend (React JS)
1. **Navigate to the frontend directory**:
```bash
cd client
```
2. **Install dependencies**:
```bash
npm install
```
3. **Set up environment variables. Create a `.env` file in the frontend directory**:
```dotenv
VITE_BASE_URL=
```
4. **Run the frontend server**:
```bash
npm run dev
```
## 📡 API Endpoints
- **Todos**:
- `GET` **/api/todos**: Retrieve a list of todos.
- `GET` **/api/todos/:id**: Retrieve a single todo by ID.
- `POST` **/api/todos**: Create a new todo.
- `PATCH` **/api/todos/:id**: Update an existing todo by ID.
- `DELETE` **/api/todos/:id**: Delete a todo by ID.
## 🤝 Contributing
Feel free to fork this repository and contribute by submitting a pull request. All contributions are welcome!
#### 🧑💻 Contributors
_Ghian Tan_ @ _Fingertips_ ([Github](https://github.com/Fingertips18))
## 📜 License
This project is licensed under the MIT License.