Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ruanyl/g26calendar


https://github.com/ruanyl/g26calendar

Last synced: 18 days ago
JSON representation

Awesome Lists containing this project

README

        

g26calendar
-------------

start server:

```
npm install
npm run start
```

setup mongodb

```
mkdir -p data/db
mongod --dbpath ./data/db/
```

### step 1

- [x] Fetching, creating, deleting and editing events works
- [x] Well thought out, sane REST API. Uses also other methods than HTTP GET
- [x] Possible to perform searches on events, matches returned. E.g. list all events which are scheduled for this Wednesday
- [x] Events are stored in a database. Events in the db can be stored, fetched, deleted and modified.
- [x] Brief documentation on how to install/use the application.
- [x] more features? find events by priority

### API Endpoint

get event by id
```
GET /event/:id
```

list all events
```
GET /event
```

save a event
```
POST /event
```
input data
```
{
title:
content:
start:
end:
}
```

delete an event by id
```
DELETE /event/:id
```

update an event by id
```
PUT /event/:id
```
input data
```
{
title:
content:
start:
end:
}
```

```
GET /event/w/:day
```
for example: `/event/w/Monday`, will get all the events of this Monday

```
POST /event/search
```
example: search by priority
```
{
priority: 2
}
```