Skip to content

rishav76dev/brains

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧠 Brains

Brains is a full-stack MERN (MongoDB, Express, React, Node.js) application that allows authenticated users to manage notes and learning content efficiently — enabling them to create, update, and delete their materials with ease.


🚀 Features

  • User authentication with JWT
  • Create, edit, delete, and view notes/content
  • Responsive UI with a clean, modern design
  • RESTful API architecture
  • Modular, scalable code structure

📸 Screenshots

(Add screenshots here — e.g., Sign In page, Dashboard, Note Editor, etc.)


🛠️ Tech Stack

Frontend

  • React
  • TypeScript
  • Tailwind CSS

Backend

  • Node.js
  • Express
  • TypeScript

Database

  • MongoDB (via Mongoose)

Authentication

  • JSON Web Token (JWT)

Deployment

  • Backend: Render
  • Frontend: Vercel

📂 Project Structure

brains/
│
├── client/              # React frontend
│   ├── src/
│   ├── public/
│   └── ...
│
├── server/              # Node.js/Express backend
│   ├── src/
│   └── ...
│
└── package.json         # Project metadata and scripts

⚙️ Environment Variables

Backend (server/.env):

PORT=5000
MONGO_URI=your_mongodb_connection_string
JWT_SECRET=your_secret_key

Frontend (client/.env):

VITE_BACKEND_URL=http://localhost:5000

🧑‍💻 Local Development

1️⃣ Clone the repository

git clone https://github.com/rishav76dev/brains.git
cd brains

2️⃣ Install dependencies

Backend

cd server
npm install

Frontend

cd ../client
npm install

3️⃣ Run the development servers

Backend

npm run dev

Frontend

npm run dev

🧪 API Endpoints (Server)

Method Endpoint Description
POST /api/auth/signup User registration
POST /api/auth/login User login
GET /api/content Get all content for the user
POST /api/content Create new content
PUT /api/content/:id Update content
DELETE /api/content/:id Delete content

🌐 Deployment

  • Backend: Render
  • Frontend: Vercel

🙌 Contributing

Pull requests are welcome!

  1. Fork the repository
  2. Create a feature branch
    git checkout -b feature/your-feature
  3. Commit your changes
    git commit -m "Add your feature"
  4. Push to your branch
    git push origin feature/your-feature
  5. Open a pull request

📝 License

This project is licensed under the MIT License.


📫 Contact

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •