Skip to content

Fix/issue 27 improve readme #72

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
Nalwogatracy wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix/issue 27 improve readme #72

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95661ab
docs: add contribution guidelines for students
Nalwogatracy Mar 23, 2026
2994600
docs: improve README with tech stack and quick start for issue #27
Nalwogatracy Apr 21, 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
47 changes: 46 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# LifeLine-ICT

## 📋 Table of Contents
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Quick Start](#quick-start)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## Project Summary

LifeLine-ICT is a digital infrastructure management platform that supports the
Expand Down Expand Up @@ -56,7 +63,7 @@ pip install -r backend/requirements.txt
uvicorn backend.app.main:app --reload
```

The service listens on `http://127.0.0.1:8000` by default. OpenAPI
The service listens on `http://127.0.0.1:8000` by default, OpenAPI
documentation is available at `http://127.0.0.1:8000/docs`.

### Core Endpoints
Expand Down Expand Up @@ -127,3 +134,41 @@ MIT, Apache
## Maintainers

Muwanga Erasto Kosea, Ouma Ronald


## 🤝 How to Contribute
We welcome contributions from BSCT students!
1. Fork the repository.
2. Create a feature branch (`git checkout -b feature/your-feature`).
3. Commit your changes.
4. Push to your branch and open a Pull Request.

## 🛠️ Tech Stack

| Category | Technologies |
|----------|--------------|
| Frontend | React, Tailwind CSS |
| Backend | Node.js, Express |
| Database | PostgreSQL |
| Authentication | JWT |
| Testing | Jest, React Testing Library |

## 🚀 Quick Start

### Prerequisites
- Node.js (v16+)
- npm or yarn
- Git

### Installation

```bash
# Clone the repository
git clone https://github.com/your-username/LifeLine-ICT.git
cd LifeLine-ICT

# Install dependencies
npm install

# Start development server
npm start
Loading