Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acm-uiuc/mmm
UIUC ACM Member-to-Meeting Matcher Service
https://github.com/acm-uiuc/mmm
Last synced: about 18 hours ago
JSON representation
UIUC ACM Member-to-Meeting Matcher Service
- Host: GitHub
- URL: https://github.com/acm-uiuc/mmm
- Owner: acm-uiuc
- License: mit
- Created: 2020-01-27T20:53:20.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T01:14:41.000Z (almost 2 years ago)
- Last Synced: 2024-04-09T11:30:29.675Z (7 months ago)
- Language: JavaScript
- Homepage: https://acm.illinois.edu
- Size: 3 MB
- Stars: 5
- Watchers: 9
- Forks: 1
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ACM Member-to-Meeting Matcher (MMM)
One of the biggest pain points of ACM is the decentralized nature of SIG information, especially
meetings. With over 20 SIG’s and 1000’s of members in ACM, it is impossible to keep up to date
on each SIG’s events and focuses on a regular basis. By consolidating some of this information,
SIG’s can gain better visibility and traction from the broader ACM student population. By
maintaining a centralized database of relevant keywords or topics for each SIG, as well as an up
to date schedule of meetings and topics, we can make a significant step towards achieving this
goal.
## API
***API basename***: `https://4z5904nohk.execute-api.us-east-1.amazonaws.com/dev`
### /events
#### POST
Schema
```json
{
"body": {
"event": {
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"org": {
"_id": {
"type": "string"
}
},
"creator": {
"type": "string",
"required": true
},
"eventDate": {
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
}
},
"topics": {
"type": "array"
}
}
}
}
```
Example
```json
{
"body": {
"event": {
"org": {
"_id": "aida"
},
"name": "Awesome Hack IL Project Meeting",
"topics": ["python", "data", "ai"],
"location": "Siebel",
"eventDate": {
"startTime": "2020-03-01T03:00:04.238Z",
"endTime": "2020-03-02T03:00:07.880Z"
},
"description": "My really awesome event",
"creator": "tincher2"
}
}
}
```
#### PATCH /{_id}
Schema
```json
{
"body": {
"event": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
},
"org": {
"_id": {
"type": "string"
}
},
"creator": {
"type": "string"
},
"eventDate": {
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
}
},
"topics": {
"type": "array"
}
}
},
"pathParameters": {
"_id": {
"type": "string"
}
}
}
```
Example
```json
{
"body": {
"event": {
"name": "Awesomer Hack IL Project Meeting"
}
},
"pathParameters": {
"_id": "123456789"
}
}
```
#### DELETE /{_id}
Schema
```json
{
"pathParameters": {
"_id": {
"type": "string"
}
}
}
```
#### GET
Schema
```json
{
"queryStringParameters": {
"whereEvent": {
"type": "object"
// MongoDB where clause
},
"limit": {
"type": "number",
"default": 50,
"max": 50
}
}
}
```
Example
```json
{
"queryStringParameters": {
"whereTopic": {
"org": {
"_id": "aida"
}
}
}
}
```
Returns
```json
{
"message": "Fetched 2 events",
"events": [
{
"name": "smoke-test-event-39eec079-09fd-4d04-890f-bb6db5e8d5b8",
"org": {
"_id": "aida",
"name": "AI/DA",
"kind": "sig"
},
"description": "hello world",
"creator": "tincher2",
"location": "Siebel",
"eventDate": {
"startTime": "2020-03-01T03:00:04.238Z",
"endTime": "2020-03-02T03:00:04.238Z"
},
"topics": []
},
{
"name": "smoke-test-event-04af6c04-1f7a-4e7e-94d0-1430382c0d5c",
"org": {
"_id": "aida",
"name": "AI/DA",
"kind": "sig"
},
"description": "hello world",
"creator": "tincher2",
"location": "Siebel",
"eventDate": {
"startTime": "2020-03-01T03:00:04.238Z",
"endTime": "2020-03-02T03:00:04.238Z"
},
"topics": [
{
"_id": "smoke-test-topic-3ff1e0b4-7a42-4673-b22e-fbc418b42e3c",
"kind": "other"
}
]
}
]
}
```
### /topics
#### POST
Schema
```json
{
"body": {
"topic": {
"name": {
"type": "string",
"required": true
},
"kind": {
"type": "string",
"required": true,
"enum": ["language", "domain", "social", "other"]
}
}
}
}
```
Example
```json
{
"body": {
"topic": {
"name": "Python",
"kind": "language"
}
}
}
```
#### GET
Schema
```json
{
"queryStringParameters": {
"whereTopic": {
"type": "object"
// MongoDB where clause
},
"limit": {
"type": "number",
"default": 50,
"max": 50
}
}
}
```
Example
```json
{
"queryStringParameters": {
"whereTopic": {
"kind": "language"
}
}
}
```
Returns
```json
{
"message": "Fetched 2 topics",
"topics": [{"name": "Python", "kind": "language"}, {"name": "Artificial Intelligence", "type": "domain"}]
}
```
### /orgs
#### GET
Response Example
```json
{
"message": "Fetched 1 org",
"orgs": [{"_id": "aida", "name": "Artificial Intelligence and Data Analytics", "kind": "sig"}]
}
```
## Tech Stack
- [Amazon Web Services (AWS) Serverless Suite](): Compute
- [Serverless Framework](): Deployment automation and environment scripting
- [MongoDB Atlas](): Database
- [Webpack + Babel + Node.js](): Compilation and runtime environment
- [Yarn](): Package and dependency manager
- [Middy.js](): Extensible middleware framework for the Serverless Framework
- [Jest](): Unit testing
- [Prettier + eslint](): Linting
## Codebase structure
```
docs/
serverless-config/
secrets.json
src/
callbacks/ # Templates for HTTP callbacks
input-schemas/ # Strongly typed HTTP request validation
middleware/ # Additional utilities that run before/after handler execution
models/ # MongoDB data models
routes/ # Endpoint handlers
utils/ # Miscellaneous tools for endpoints
tests/
routes/ # Route specific unit tests
.babelrc
serverless.yml # Environment and deployment configuration
webpack.config.js
```
## Contact
This project is maintained by [Bailey Tincher](https://github.com/baileytincher), with significant work done by [Ben Nordick](https://github.com/Fleex255), [Jackie Oh](https://github.com/jmoh3), and [Jeff Taylor-Chang](https://github.com/jtaylorchang). If you would like to contribute, read our guidelines in [CONTRIBUTING.md]() and submit a PR!