Dec 2024 - v0.0.15
PFOaaS (Polite Fork Off As A Service) provides a modern, RESTful, scalable solution to the common problem of telling people to fork off.
Please see https://pfoaas.desigeek.com for API documentation and examples.
docker build -t foaas:1 .
docker run -v $(pwd):/usr/src/app -p 5000:5000 foaas:1
You can also use Docker Compose to run the application:
-
Create a
docker-compose.yml
file with the following content:version: '3.8' services: pfoaas: image: amitbahree/pfoaas build: context: . dockerfile: Dockerfile ports: - "5000:5000" environment: NODE_ENV: production restart: unless-stopped
-
Run Docker Compose:
docker-compose up
The Docker image for this project is also available on Docker Hub. You can pull it using the following command:
docker pull amitbahree/pfoaas
Example no how to run this:
docker run -d -p 5000:5000 amitbahree/pfoaas
For more details, visit the Docker Hub repository.
To add a new FOAAS operation:
- Fork into your account
- Branch into a feature branch
feature/your_operation
- See the operation files in
/lib/operations
. - Add specs, using
/spec/operations
as examples. We won't be merging operations without working specs. - Push to your fork and submit a PR.
All contributions are very welcome.