sage-frontend is a modern, modular front-end application built using Next.js and Type script. It provides a streamlined development environment with integrated tools for linting, testing, Docker support, and deployment workflows. This project is tailored for building responsive and accessible web applications.
- Node.js: Install Node.js (LTS version recommended).
- npm: Comes bundled with Node.js.
Clone the repository and install the required dependencies:
# Clone the repository
git clone https://github.com/HealthRex/sage-frontend
cd sage-frontend
# Install dependencies
npm installTo start the development server:
npm run devThe application will be available at http://localhost:3000.
To run the application using Docker:
# Build the Docker image
docker build -t sage-frontend .
# Run the container
docker run -p 3000:3000 sage-frontendThe application will be available at [http://localhost:3000].
This project uses a modular architecture to separate functionality into smaller, reusable components. The main application resides in the /app directory, while local packages are in /packages for better code organization.
Here are some useful npm scripts:
npm run dev: Start the development server.npm run build: Build the application for production.
Deployment pipelines are managed using GitHub Actions. Each commit to the main branch triggers an automated build and deployment process. Ensure proper configuration of secrets (e.g., API keys) in the repository settings.
To dive deeper into the technologies used:
- Next.js Documentation: Learn about the framework's features.
- GitHub Actions: Automate workflows.
This project is actively maintained by Vishnu Ravi, Kanav Chopra and contributors. Feel free to open an issue or submit a pull request for improvements.