Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ginabeki/automation-demo-project
https://github.com/ginabeki/automation-demo-project
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ginabeki/automation-demo-project
- Owner: ginabeki
- License: gpl-3.0
- Created: 2024-11-17T15:47:36.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-17T21:32:55.000Z (2 months ago)
- Last Synced: 2024-11-17T21:34:31.196Z (2 months ago)
- Language: JavaScript
- Homepage: https://automation-demo-project.vercel.app
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀Github Actions Automation Demo
A demonstration of automated workflow implementation using GitHub Actions, featuring continuous integration and deployment with Vercel.
## 🎯 Overview
This project demonstrates:
- Automated testing and deployment using GitHub Actions
- Continuous Integration (CI) with automated tests
- Continuous Deployment (CD) to Vercel
- Express.js API with automated testing
## 🛠️ Tech Stack
- Node.js
- Express.js
- Jest (Testing)
- GitHub Actions
- Vercel (Deployment)
## 📋 Prerequisites
Before you begin, ensure you have:
- Node.js (v18 or higher)
- npm (comes with Node.js)
- A GitHub account
- A Vercel account (free tier works)
## 🚀 Quick Start
Clone the repository
``` bash
git clone https://github.com/ginabeki/automation-demo-project.git
cd automation-demo-project
```
**Install dependencies**
```bash
npm install
```
**Run locally**
```bash
npm run dev
```
**Run tests**
```bash
npm test
```
## 🔄 CI/CD Pipeline
This project implements a complete CI/CD pipeline:
**Continuous Integration**
- Automated testing on push
- Code quality checks
- Dependency installation verification
**Continuous Deployment**
- Automatic deployment to Vercel
- Production and preview deployments
- Secure token handling
## 🧪 Testing
Run the test suite using these commands:
```bash
# Run tests
npm test
# Run tests with coverage
npm run test:coverage
```
## 📦 Deployment
The project automatically deploys to Vercel when:
- Code is pushed to main branch
- Pull requests are merged to main
## 📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
👥 Author
- Gina Beki
- GitHub: @ginabeki
- LinkedIn: ginabeki
## 🙏 Acknowledgments
- [GitHub Actions documentation](https://docs.github.com/en/actions)
- [Vercel deployment guides](https://vercel.com/docs/deployments/overview)
- [Express.js community](https://expressjs.com/en/starter/installing.html)