{"id":26583094,"url":"https://github.com/vasilenka/madams-express","last_synced_at":"2026-04-13T23:31:18.065Z","repository":{"id":75940871,"uuid":"163027471","full_name":"vasilenka/madams-express","owner":"vasilenka","description":"Madams using express as backend","archived":false,"fork":false,"pushed_at":"2019-01-21T14:22:42.000Z","size":3907,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-23T08:21:38.655Z","etag":null,"topics":["api","backend","dwyl","express","expressjs","javascript","madams"],"latest_commit_sha":null,"homepage":"https://safe-lowlands-17542.herokuapp.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vasilenka.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-24T22:40:43.000Z","updated_at":"2019-01-21T14:22:44.000Z","dependencies_parsed_at":"2023-06-16T21:46:28.447Z","dependency_job_id":null,"html_url":"https://github.com/vasilenka/madams-express","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vasilenka/madams-express","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasilenka%2Fmadams-express","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasilenka%2Fmadams-express/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasilenka%2Fmadams-express/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasilenka%2Fmadams-express/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vasilenka","download_url":"https://codeload.github.com/vasilenka/madams-express/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasilenka%2Fmadams-express/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31775694,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T20:17:16.280Z","status":"ssl_error","status_checked_at":"2026-04-13T20:17:08.216Z","response_time":93,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","backend","dwyl","express","expressjs","javascript","madams"],"created_at":"2025-03-23T08:20:17.618Z","updated_at":"2026-04-13T23:31:18.056Z","avatar_url":"https://github.com/vasilenka.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"The Madams 💃🏼\n======\nThis is The Madams API built using express.js\n\n\n## Table of Contents\n1. [Usage](https://github.com/vasilenka/madams-express#usage)\n2. [Users Endpoint](https://github.com/vasilenka/madams-express#users-endpoint)\n      * [Get all users](https://github.com/vasilenka/madams-express#get-all-users)\n      * [Get single user data](https://github.com/vasilenka/madams-express#get-single-user-data)\n      * [Create new user](https://github.com/vasilenka/madams-express#create-new-user)\n      * [Update single user data](https://github.com/vasilenka/madams-express#update-single-user-data)\n      * [Delete single user data](https://github.com/vasilenka/madams-express#delete-single-user-data)\n3. [Projects Endpoint](https://github.com/vasilenka/madams-express#projects-endpoint)\n      * [Get all projects](https://github.com/vasilenka/madams-express#get-all-projects)\n      * [Get single project data](https://github.com/vasilenka/madams-express#get-single-project-data)\n      * [Create new project](https://github.com/vasilenka/madams-express#create-new-project)\n      * [Update single project data](https://github.com/vasilenka/madams-express#update-single-project-data)\n      * [Delete single project data](https://github.com/vasilenka/madams-express#delete-single-project-data)\n4. [Contributing to this repository](https://github.com/vasilenka/madams-express#contributing-to-this-repository)\n\n\n\n# Usage\n### Setup the app\n1. Clone this repository to your local machine.\n2. Open your terminal/console and run `npm install` or `yarn install` if you prefer using `yarn` to install all the project dependencies.\n\n### Connecting to database\nWe are using mongodb atlas as development database, to get your own free cloud atlas, just go to [http://mongodb.com](https://www.mongodb.com \"MongoDB Homepage\").\n\nAfter setting up your database, add new `nodemon.json` file on your root folder and copy the value in `nodemon.example.json` and add your database configuration value.\n\n### Running the App\nIn your terminal, navigate to the the madams directory (if you are not in it already) and run the app using `npm run dev` or `yarn dev`. If everything's good, your app will running on [http://localhost:5000](http://localhost:5000 \"localhost:5000\")\n\n`npm run dev` will start a nodemon server where the server will automatically reload when there's changes in your code. You can run `npm start` or `yarn start` if you want to start server without `nodemon`.\n\n\n\n# Users Endpoint\n### Get all users\nTo get all users stored in database, send `GET` request to `/users`\n```\nGET /users\n```\nThis will response with object with key `message`, `count`, and `users` consist of an array of all users information stored in database.\n```javascript\n[\n  message: String,\n  count: Number, // The count of all users stored in database\n  {\n    _id: ObjectID,\n    username: String,\n    email: String,\n    firstName: String,\n    lastName: String,\n    role: Array of String,\n    createdAt: Date,\n    updatedAt: Date,\n  }\n]\n```\n\n### Get single user data\nTo get single user data, send `GET` request to `/users/:userId` with `userId` is the requested user id as request parameter.\n```\nGET /users/:userId\n```\nThis request will response with an object consist of a single user data.\n```javascript\n[\n  message: String,\n  {\n    _id: ObjectID,\n    username: String,\n    email: String,\n    firstName: String,\n    lastName: String,\n    role: Array of String,\n    createdAt: Date,\n    updatedAt: Date,\n  }\n]\n```\n\n### Create new user\nTo create new user, send `POST` request to `/users`.\n```\nPOST /users\n```\nThe endpoint expecting the follwoing values sent as json in the request:\n```javascript\n{\n  username: String // required,\n  email: String // required,\n  firstName: String,\n  lastName: String,\n  password: String,\n  role: Array of String\n}\n```\nIf the new user created, this request will send a response with an object consist of the user data that just been created.\n```javascript\n[\n  message: String,\n  {\n    _id: ObjectID,\n    username: String,\n    email: String,\n    firstName: String,\n    role: Array of String,\n    lastName: String,\n    createdAt: Date,\n    updatedAt: Date,\n  }\n]\n```\n\n### Update single user data\nTo update single user data, send `PATCH` request to `/users/:userId` with `userId` is the requested user id as request parameter.\n```\nPATCH /users/:userId\n```\nYou can send any of the following values as `JSON` to the endpoint:\n```javascript\n{\n  username: String,\n  email: String,\n  password: String,\n  firstName: String,\n  lastName: String,\n  role: Array of String,\n}\n```\nThis request will response with `message` and an object consist of a the user that has been deleted.\n```javascript\n[\n  message: String,\n  {\n    _id: ObjectID,\n    username: String,\n    email: String,\n    firstName: String,\n    lastName: String,\n    createdAt: Date,\n    updatedAt: Date,\n  }\n]\n```\n\n### Delete single user data\nTo delete single user data, send `DELETE` request to `/users/:userId` with `userId` is the requested user id as request parameter.\n```\nDELETE /users/:userId\n```\nThis request will response with `message` and an object consist of a the user that has been deleted.\n```javascript\n[\n  message: String,\n  {\n    _id: ObjectID,\n    username: String,\n    email: String,\n    firstName: String,\n    lastName: String,\n    createdAt: Date,\n    updatedAt: Date,\n  }\n]\n```\n\n\n\n# Projects\n### Get all projects\nTo get all projects stored in database, send `GET` request to `/projects`\n```\nGET /projects\n```\nThis will response with object with key `message`, `count`, and `users` consist of an array of all users information stored in database.\n```javascript\n[\n  message: String,\n  count: Number, // The count of all projects stored in database\n  {\n    _id: ObjectID,\n    name: String, // Project name\n    teams: Array of Users, // Every team member that involved in the project\n    tags: Array of String,\n    status: enum[String] // [\"lead\", \"proposal\", \"cancelled\", \"development\", \"hold\", \"done\", \"drop\"] -- default to \"lead\"\n    startDate: Date, // The date the project officially started\n    endDate: Date, // The date the project officially ended\n    createdAt: Date,\n    updatedAt: Date,\n  }\n]\n```\n\n### Get single project data\nTo get single project data, send `GET` request to `/projects/:projectId` with `projectId` is the requested project id as request parameter.\n```\nGET /users/:projectId\n```\nThis request will response with an object consist of a single project data.\n```javascript\n[\n  message: String,\n  {\n    _id: ObjectID,\n    name: String, // Project name\n    teams: Array of Users, // Every team member that involved in the project\n    tags: Array of String,\n    status: enum[String] // [\"lead\", \"proposal\", \"cancelled\", \"development\", \"hold\", \"done\", \"drop\"] -- default to \"lead\"\n    startDate: Date, // The date the project officially started\n    endDate: Date, // The date the project officially ended\n    createdAt: Date,\n    updatedAt: Date,\n  }\n]\n```\n\n### Create new project\nTo create new project, send `POST` request to `/projects`\n```\nPOST /projects\n```\nThe endpoint expecting the follwoing values sent as json in the request:\n```javascript\n{\n  _id: ObjectID,\n  name: String, // required\n  teams: Array of Users,\n  tags: Array of String,\n  status: enum[String] // [\"lead\", \"proposal\", \"cancelled\", \"development\", \"hold\", \"done\", \"drop\"] -- default to \"lead\"\n  startDate: Date,\n  endDate: Date,\n}\n```\nIf the new project successfully created, this request will send a response with an object consist of the project data that just been created.\n```javascript\n[\n  message: String,\n  {\n    _id: ObjectID,\n    name: String, // Project name\n    teams: Array of Users, // Every team member that involved in the project\n    tags: Array of String,\n    status: enum[String] // [\"lead\", \"proposal\", \"cancelled\", \"development\", \"hold\", \"done\", \"drop\"] -- default to \"lead\"\n    startDate: Date, // The date the project officially started\n    endDate: Date, // The date the project officially ended\n    createdAt: Date,\n    updatedAt: Date,\n  }\n]\n```\n\n### Update single project data\nTo update single project data, send `PATCH` request to `/projects/:projectId` with `projectId` is the requested project id as request parameter.\n```\nPATCH /projects/:projectId\n```\nYou can send any of the following values as `JSON` to the endpoint:\n```javascript\n{\n  name: String, // Project name\n  teams: Array of Users, // Every team member that involved in the project\n  tags: Array of String,\n  status: enum[String] // [\"lead\", \"proposal\", \"cancelled\", \"development\", \"hold\", \"done\", \"drop\"] -- default to \"lead\"\n  startDate: Date, // The date the project officially started\n  endDate: Date, // The date the project officially ended\n}\n```\nThis request will response with `message` and an object consist of a the projects that has been updated.\n```javascript\n[\n  message: String,\n  {\n    _id: ObjectID,\n    name: String, // Project name\n    teams: Array of Users, // Every team member that involved in the project\n    tags: Array of String,\n    status: enum[String] // [\"lead\", \"proposal\", \"cancelled\", \"development\", \"hold\", \"done\", \"drop\"] -- default to \"lead\"\n    startDate: Date, // The date the project officially started\n    endDate: Date, // The date the project officially ended\n    createdAt: Date,\n    updatedAt: Date,\n  }\n]\n```\n\n### Delete single project data\nTo delete single project data, send `DELETE` request to `/projects/:projectId` with `projectId` is the requested project's id as request parameter.\n```\nDELETE /projects/:projectId\n```\nThis request will response with `message` and an object consist of a the project that has been deleted.\n```javascript\n[\n  message: String,\n  {\n    _id: ObjectID,\n    name: String, // Project name\n    teams: Array of Users, // Every team member that involved in the project\n    tags: Array of String,\n    status: enum[String] // [\"lead\", \"proposal\", \"cancelled\", \"development\", \"hold\", \"done\", \"drop\"] -- default to \"lead\"\n    startDate: Date, // The date the project officially started\n    endDate: Date, // The date the project officially ended\n    createdAt: Date,\n    updatedAt: Date,\n  }\n]\n```\n\n\n# Contributing to this repository\nWe'll be happy if you want to contribute to this projects. Just fork this repository and submit a pull request (PR).\nIf you find something wrong or you want to give us some feedback, don't be shy to file an issue.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvasilenka%2Fmadams-express","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvasilenka%2Fmadams-express","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvasilenka%2Fmadams-express/lists"}