#tag-1 #tag-2 #tag-3 #assembler-school #master-in-software-engineering
Brief explanation of the purpose of this project, which is what they are going to create, the objective of carrying out this project.
You can separate the explanation in different paragraphs, use all the paragraphs that you need without going overboard.
A more detailed description with all the requirements and steps that the students need to complete for the project will be included in the Google Docs version of the requirements document.
Feel free to add any supporting info in the README such as images, links,
etc
Examples:
In this workshop you will learn how to build backend apps with Node.js.
Voluptate excepteur occaecat enim minim tempor. Quis velit aute excepteur adipisicing enim excepteur nulla Lorem in cupidatat sint. Lorem non occaecat voluptate tempor excepteur. Exercitation ea quis labore nisi dolor labore. Exercitation minim officia Lorem excepteur nisi aliqua commodo cupidatat. Et officia deserunt nostrud anim.
- Getting Started
- Deployment
- Technologies used
- Project requirements
- Project delivery
- Resources
- License
- Contributors ✨
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system (if it applies to this project/pill).
First, you will need to clone or fork the repository into your Github
account:
$ git clone https://github.com/assembler-school/[PROJECT-OR-PILL-NAME].git
Include this section only if the pill/project needs a previous installation
step like npm install.
First, you will need to install the dependencies with: npm install
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
Include this section only if the pill/project has tests.
Explain how to run the automated tests for this system
Explain what these tests test and why
Give an example
Explain what these tests test and why
Give an example
Include this section only if the pill/project has tests.
Add additional notes about how to deploy this to Netlify, Heroku, etc if the project requires deployment.
This section details the technologies that are used in the project.
Here are some examples of technologies used:
- HTML
- CSS
- JS
- LocalStorage
- ...
This section details the main requirements of the project that the student must take into account when they deliver their solution.
A more detailed description with all the requirements and steps that the students need to complete for the project will be included in the Google Docs version of the requirements document.
Here are some examples of project requirements:
- You must develop this project using a single HTML page
- You cannot use third-party libraries
- You must use semantic HTML5 elements for all the contents of the application
To deliver this project you must follow the steps indicated in the document:
This section include all the main resources that the students should check for learning more about the technologies they are using or that might apply to their project.
Here are some examples of resources:
This project is licensed under the MIT License - see the LICENSE file for details
Thanks goes to these wonderful people (emoji key):
 Dani Lucaci 💻 📖 💡 🔧 |
This project follows the all-contributors specification. Contributions of any kind welcome!