Skip to content

hulab-emory/AlarmX

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hello, world! 🌍

This is a fullstack JavaScript application with:

  • React (Create React App) for the frontend
  • Node.js + Express for the backend

The frontend is modularized into separate apps and shares components via a common shared/ folder.


📁 Project Structure

App/
├── client/                # React frontend
│   ├── public/
│   ├── src/
│   │   ├── apps/          # e.g., alarmx
│   │   └── index.js
│   ├── package.json
│   └── README.md
├── server/                # Express backend
│   ├── server.js
│   └── package.json
├── .gitignore
└── README.md

🚀 Getting Started

Step 1: Install dependencies

# Install frontend dependencies
cd client
npm install

# Install backend dependencies
cd ../server
npm install

Step 2: Run the full app (dev mode)

From the root of the project:

npm run dev

This will:


🔁 Proxy Setup

To allow the React frontend to talk to the Express backend during development, add this line to client/package.json:

"proxy": "http://localhost:8080",

📦 Scripts Overview

Client package.json

"scripts": {
  "start": "react-scripts start",
  "build": "react-scripts build"
}

Server package.json

"scripts": {
  "start": "node server.js"
}

🛠 Future Todos

  • Add authentication (JWT, OAuth)
  • Add form validation, protected routes
  • Dockerize for easy deployment
  • Add tests (Jest, Supertest, etc.)

🙌 Contributions Welcome

Feel free to fork this repo, submit issues, or open pull requests to improve the project!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages