Skip to content

Commit

Permalink
Merge pull request #31 from ShaanCoding/develop
Browse files Browse the repository at this point in the history 
Created Readme Templates - Backend by Fernanda Kipper
  • Loading branch information
@ShaanCoding
ShaanCoding authored Apr 14, 2024
2 parents 113d718 + 31a45fb commit a4bb95e
Show file tree
Hide file tree
Showing 3 changed files with 537 additions and 2 deletions.
293 changes: 293 additions & 0 deletions backend/public/readme-templates-backend/blocks.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,293 @@
{
"title": "Readme Templates - Backend",
"description": "This repository provides a series of README templates to help developers document their projects 🚀👩‍💻",
"author": {
"name": "Fernanda Kipper",
"url": { "url": "https://github.com/Fernanda-Kipper", "_type": "Github" }
},
"contributors": [
{
"name": "Shaan Khan",
"url": { "url": "https://github.com/ShaanCoding", "_type": "Github" }
}
],
"image": "https://github.com/Fernanda-Kipper/Readme-Templates/raw/main/.github/logo.png",
"dateCreated": "2024-04-14T00:00:00.000Z",
"lastUpdated": "2024-04-14T12:00:00.000Z",
"tags": [
{
"name": "Read Me",
"url": "read-me"
},
{
"name": "Recommended",
"url": "recommended"
},
{
"name": "MIT",
"url": "mit"
},
{
"name": "Backend",
"url": "backend"
}
],
"featured": true,
"folder": "readme-templates-backend",
"startupBlocks": ["projectHeaderMacro", "technologiesMacro", "gettingStartedMacro", "prerequisitesMacro", "cloningMacro", "configEnvironmentVariablesMacro", "startingMacro", "apiEndpointsMacro", "collaboratorsMacro", "contributeMacro", "documentationThatMightHelpMacro"],
"functions": [
{
"name": "Header",
"description": "This function creates a project header with the project title.",
"function": "projectHeaderMacro",
"variables": [
{
"label": "Project Title",
"name": "projectTitle",
"description": "The title of the project.",
"defaultValue": "Project name 💻",
"_type": "input"
},
{
"label": "Enable Technologies Section",
"name": "isTechnologiesSection",
"description": "Enable the technologies section.",
"defaultValue": true,
"_type": "checkBox"
},
{
"label": "Enable Getting Started Section",
"name": "isGettingStartedSection",
"description": "Enable the getting started section.",
"defaultValue": true,
"_type": "checkBox"
},
{
"label": "Enable API Endpoints Section",
"name": "isAPIEndpointsSection",
"description": "Enable the API endpoints section.",
"defaultValue": true,
"_type": "checkBox"
},
{
"label": "Enable Collaborators Section",
"name": "isCollaboratorsSection",
"description": "Enable the collaborators section.",
"defaultValue": true,
"_type": "checkBox"
},
{
"label": "Enable Contribute Section",
"name": "isContributeSection",
"description": "Enable the contribute section.",
"defaultValue": true,
"_type": "checkBox"
},
{
"label": "Project Description",
"name": "projectDescription",
"description": "A description of the project.",
"defaultValue": "Simple description of what your project do or how to use it",
"_type": "textArea"
},
{
"label": "Call to Action",
"name": "projectCallToAction",
"description": "A call to action for the project.",
"_type": "object",
"defaultValue": {
"url": "https://github.com/ShaanCoding",
"text": "📱 Visit this Project"
},
"objectSchema": [
{
"label": "URL",
"name": "url",
"_type": "input"
},
{
"label": "Text",
"name": "text",
"_type": "input"
}
]
}
]
},
{
"name": "Technologies",
"description": "This function lists the technologies used in the project.",
"function": "technologiesMacro",
"variables": [
{
"label": "Technology Description",
"name": "technologyDescription",
"description": "A description of the technology used in the project.",
"defaultValue": "- list of all technologies you used\r\n- react\r\n- styled components\r\n- another example",
"_type": "textArea"
}
]
},
{
"name": "Getting Started",
"description": "This function provides a guide on how to get started with the project.",
"function": "gettingStartedMacro",
"variables": [
{
"label": "Getting Started Description",
"name": "gettingStartedDescription",
"description": "A description of how to get started with the project.",
"defaultValue": "Here you describe how to run your project locally",
"_type": "textArea"
}
]
},
{
"name": "Prerequisites",
"description": "This function provides a guide on the prerequisites for the project.",
"function": "prerequisitesMacro",
"variables": [
{
"label": "Prerequisites Description",
"name": "prerequisitesDescription",
"description": "A description of the prerequisites for the project.",
"defaultValue": "Here you list all prerequisites necessary for running your project. For example:\r\n\r\n- [NodeJS](https://github.com/)\r\n- [Git 2](https://github.com)",
"_type": "textArea"
}
]
},
{
"name": "Cloning",
"description": "This function provides a guide on how to clone the project.",
"function": "cloningMacro",
"variables": [
{
"label": "Cloning Description",
"name": "cloningDescription",
"description": "A description of how to clone the project.",
"defaultValue": "How to clone your project\r\n\r\n```bash\r\ngit clone your-project-url-in-github\r\n```",
"_type": "textArea"
}
]
},
{
"name": "Configure Environment Variables",
"description": "This function provides a guide on how to configure environment variables.",
"function": "configEnvironmentVariablesMacro",
"variables": [
{
"label": "Environment Variables Description",
"name": "configEnvironmentVariablesDescription",
"description": "A description of how to configure environment variables.",
"defaultValue": "Use the `.env.example` as reference to create your configuration file `.env` with your AWS Credentials\r\n\r\n```yaml\r\nNODE_AWS_REGION=us-east-1\r\nNODE_AWS_KEY_ID={YOUR_AWS_KEY_ID}\r\nNODE_AWS_SECRET={YOUR_AWS_SECRET}\r\n```",
"_type": "textArea"
}
]
},
{
"name": "Starting",
"description": "This function provides a guide on how to start the project.",
"function": "startingMacro",
"variables": [
{
"label": "Starting Description",
"name": "startingDescription",
"description": "A description of how to start the project.",
"defaultValue": "How to start your project\r\n\r\n```bash\r\ncd project-name\r\nnpm some-command-to-run\r\n```",
"_type": "textArea"
}
]
},
{
"name": "API Endpoints",
"description": "This function provides a list of API endpoints.",
"function": "apiEndpointsMacro",
"variables": [
{
"label": "API Endpoints Description",
"name": "apiEndpointsDescription",
"description": "A description of the API endpoints.",
"defaultValue": "Here you can list the main routes of your API, and what are their expected request bodies.\r\n​\r\n| route | description \r\n|----------------------|-----------------------------------------------------\r\n| <kbd>GET /authenticate</kbd> | retrieves user info see [response details](#get-auth-detail)\r\n| <kbd>POST /authenticate</kbd> | authenticate user into the api see [request details](#post-auth-detail)\r\n\r\n<h3 id=\"get-auth-detail\">GET /authenticate</h3>\r\n\r\n**RESPONSE**\r\n```json\r\n{\r\n \"name\": \"Fernanda Kipper\",\r\n \"age\": 20,\r\n \"email\": \"[email protected]\"\r\n}\r\n```\r\n\r\n<h3 id=\"post-auth-detail\">POST /authenticate</h3>\r\n\r\n**REQUEST**\r\n```json\r\n{\r\n \"username\": \"fernandakipper\",\r\n \"password\": \"4444444\"\r\n}\r\n```\r\n\r\n**RESPONSE**\r\n```json\r\n{\r\n \"token\": \"OwoMRHsaQwyAgVoc3OXmL1JhMVUYXGGBbCTK0GBgiYitwQwjf0gVoBmkbuyy0pSi\"\r\n}\r\n```",
"_type": "textArea"
}
]
},
{
"name": "Collaborators",
"description": "This function lists the collaborators of the project.",
"function": "collaboratorsMacro",
"variables": [
{
"label": "Collaborators Description",
"name": "collaboratorsDescription",
"description": "A description of the collaborators of the project.",
"defaultValue": "Special thank you for all people that contributed for this project.",
"_type": "textArea"
},
{
"label": "Collaborators List",
"name": "collaboratorsList",
"description": "A list of collaborators of the project.",
"_type": "list",
"defaultValue": [
{
"name": "Fernanda Kipper",
"profilePictureURL": "https://avatars.githubusercontent.com/u/61896274?v=4",
"githubURL": "https://github.com/Fernanda-Kipper"
},
{
"name": "Shaan Khan",
"profilePictureURL": "https://avatars.githubusercontent.com/u/22236218?v=4",
"githubURL": "https://github.com/ShaanCoding"
}
],
"listSchema": [
{
"label": "Name",
"name": "name",
"_type": "input"
},
{
"label": "Profile Picture URL",
"name": "profilePictureURL",
"_type": "input"
},
{
"label": "Github URL",
"name": "githubURL",
"_type": "input"
}
]
}
]
},
{
"name": "Contribute",
"description": "This function provides a guide on how to contribute to the project.",
"function": "contributeMacro",
"variables": [
{
"label": "Contribute Description",
"name": "contributeDescription",
"description": "A description of how to contribute to the project.",
"defaultValue": "Here you will explain how other developers can contribute to your project. For example, explaining how can create their branches, which patterns to follow and how to open an pull request\r\n\r\n1. `git clone https://github.com/Fernanda-Kipper/text-editor.git`\r\n2. `git checkout -b feature/NAME`\r\n3. Follow commit patterns\r\n4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!",
"_type": "textArea"
}
]
},
{
"name": "Documentation That Might Help",
"description": "This function provides a list of documentation that might help the user.",
"function": "documentationThatMightHelpMacro",
"variables": [
{
"label": "Documentation Description",
"name": "documentationThatMightHelpDescription",
"description": "A description of the documentation that might help the user.",
"defaultValue": "[📝 How to create a Pull Request](https://www.atlassian.com/br/git/tutorials/making-a-pull-request)\r\n\r\n[💾 Commit pattern](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716)",
"_type": "textArea"
}
]
}
]
}
Loading

0 comments on commit a4bb95e

Please sign in to comment.