This project is an attempt to make a clean abstraction over devpost for other projects. The goal is to cover all of the available public data.
Documentation is generated from the OpenAPI YAML, and can be found here.
I (thegu5) am hosting an instance of this at devpost.gu5.org. Please use it for testing purposes only.
You will need a relatively new version of nodejs.
npm i
node src/index.js
If you are contributing, you can use nodemon to auto-restart the server when a file is modified -
npm install -g nodemon
nodemon
This project is almost ready for my purposes, but it may not be for yours.
The plan is to migrate to cheerio-json-mapper - X-ray is very old and buggy so it'll be a breath of fresh air.
Stuff defined in the spec but not implemented:
- Specific software updates
- Specific forum topics
- Error handling on 404s, invalid auth token, etc
- URL normalization for the default profile picture (starts with // instead of https://)
- Software updates + comments on them
Issues with current routes:
- Listing of private users as members of projects in the project gallery
- Hackathon update content previews are messed up (use html -> markdown formatter or something?)
- Error handling with 404s
- User location? (detect with icon?)
Information that needs to be defined:
- Software search, staff picks (featured), popular
- Hackathon search
- Hackathon theme stats
- Featured hackathons
- Different currency prize amounts
In the future:
- pnpm
- Tests
- Documentation for the auth cookie
- Typescript???
- express-openapi-validator (maybe? not sure how stable it is)