https://github.com/opensource-force/hackathon
https://github.com/opensource-force/hackathon
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/opensource-force/hackathon
- Owner: opensource-force
- License: mit
- Created: 2023-07-20T14:15:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-17T14:21:07.000Z (over 2 years ago)
- Last Synced: 2025-03-30T20:37:56.148Z (about 1 year ago)
- Size: 17.6 KB
- Stars: 3
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Open Source Force Hackathon v1.0.0
## Metadata
Start date: August 5 00:00:00 UTC
Deadline: [projected late November]
Project: An API for managing a online forum
### Requirements:
- Must have disk-persistent storage
- Must support GET, POST, and DELETE HTTP requests
- Must have posts with title, author, and body
- Must have comments with author and body
## Guidelines
- Your project should have a descriptive README
- It should be fairly simple to install. We suggest publishing to a public package registry like NPM or PyPI, or compiling a binary and providing an easy download along with the SHA fingerprint. If you provide a binary or minified code, you must include source code as well as instructions to build/compile.
- ⚠️ In Development ⚠️
## Getting Started
### Registration
1. Fork the repo, clone, and run `npm i` if possible.
2. Create a file in the `projects/` directory named `.json`. Use your **GitHub** username.
3. Follow the JSON schema in `project.schema.json` to fill out your file. See `project.example.json` for an example.
4. Validate your JSON if possible: `npm run validate -- projects/.json`.
5. Open a PR.
6. Follow instructions in the Open Source Force Discord server to confirm your registration.
7. Wait for merge.