Skip to content

updated Readme.md file #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mukundDeo9325 wants to merge 6 commits into
base: main
Choose a base branch
from
Open

updated Readme.md file #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e15b10e
Update README.md
mukundDeo9325 Jan 6, 2026
fbc3c71
Update README.md
mukundDeo9325 Jan 6, 2026
fd0f744
Update Readme.md
mukundDeo9325 Jan 6, 2026
1f96ea1
Update Readme.md
mukundDeo9325 Jan 6, 2026
e880c8c
Update README.md
mukundDeo9325 Jan 6, 2026
61aeb52
Update README.md
mukundDeo9325 Jan 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 68 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,70 @@
## set up db_instance with mariadb engion
## create 2 Ec2 instances
## crete Sequrity group
<img width="1205" height="265" alt="Screenshot 2026-01-06 at 4 31 52 PM" src="https://github.com/user-attachments/assets/47b5bc95-6840-47a7-a7cc-d95ef6caf692" />

---
# MariaDB Setup and Configuration Guide for Windows

This guide explains how to set up MariaDB, create a database, and Create Database User

## 1. Installing MariaDB

Installing MariaDB on Ubntu

```shell
apt update && apt install mariadb-server -y
```

## 2. Securing MariaDB

Open the Command Prompt as Administrator and run the following command to secure your installation:

```shell

mysql_secure_installation
```

Follow the prompts to:
Set a root password.
Remove insecure default users and test databases.
Disable remote root login.

## 3. Setting Up the Database

Open terminal and login to MariaDB:

```bash

mysql -u root -p
```

Enter the root password when prompted.

Create a new database and user:

```sql
CREATE DATABASE student_db;
GRANT ALL PRIVILEGES ON springbackend.* TO 'username'@'localhost' IDENTIFIED BY 'your_password';
```
Replace username and your_password with your desired username and password.

Exit MariaDB:

```sql

EXIT;
```

## 4. You will need Database Credentials to Connect Backend with Database
1. DB_HOST
2. DB_USER
3. DB_PASS
4. DB_PORT
5. DB_NAME


---
# EasyCRUD - Student Registration System

A full-stack web application for student registration with a React frontend and Spring Boot backend.
Expand Down Expand Up @@ -325,4 +392,4 @@ For issues and questions:
1. Check the troubleshooting section
2. Review the database setup guide
3. Check application logs for error messages
4. Verify all prerequisites are installed
4. Verify all prerequisites are installed
21 changes: 14 additions & 7 deletions backend/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,19 @@ mvn -version
## Step 3: Build the Spring Boot Application

### Update DB credentials in application.properties:
```
pwd
```

```shell
```bash
vim backend/src/main/resources/application.properties

server.port=8080
spring.datasource.url=jdbc:mariadb://<DB_HOST>:3306/<DB_NAME>
spring.datasource.username=<DB_USER>
spring.datasource.password=<DB_PASS>
```
```shell
spring.datasource.url=jdbc:mariadb://localhost:3306/student_db
spring.datasource.username=your_username
spring.datasource.password=your_password
spring.jpa.hibernate.ddl-auto=validate
spring.jpa.show-sql=true
```

### Build springboot Application using maven
Expand All @@ -70,4 +75,6 @@ http://localhost:8080

### Step 5: Keep the Application Running

To keep the application running in the background, you can use nohup or a similar method.

To keep the application running in the background, you can use nohup or a similar method.

65 changes: 64 additions & 1 deletion frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,66 @@
# React Project Setup and Deployment Guide for Windows

This guide provides step-by-step instructions for setting up a React project.

## 1. Setting Up the React Project

### Install Node.js and npm

```shell
apt update && apt install nodejs npm -y
```

### Verify Installation


```shell
node -v
npm -v
```


## 2. Install Dependencies

To install the necessary dependencies for your project, run the following command:

```shell
npm install
```

## 3. Build the React Application for Production

Update backend URL in .env file

```bash
vim .env
```
```shell
VITE_API_URL=http://$BACKEND:8080/api
VITE_API_BASE_URL=http://$BACKEND:8080
VITE_APP_TITLE=EasyCRUD Student Registration
```

To build the React application for production, run:

```shell
npm run build
```

This will create a dist/ directory in your project containing optimized, production-ready files.

## 4. Deploy production-ready files on s3 or apache2 server

```shell
apt install apache2 -y
systemctl start apache2
cp -rf dist/* /var/www/html/
```

You can access the application on http://localhost:80


---

# CLOUDBLITZ Student Management Frontend

A modern, scalable React application built with industry best practices for managing student registrations and data.
Expand Down Expand Up @@ -292,4 +355,4 @@ For support and questions:
- [ ] Advanced analytics dashboard
- [ ] Multi-language support
- [ ] Dark mode theme
- [ ] Advanced user roles and permissions
- [ ] Advanced user roles and permissions