Stuck on an issue?
Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Create single source of user stories and notes for back-end Node certification projects
See original GitHub issueInternally, we had several discussions about the pros and cons of moving all the user stories for the back-end certification projects to a single location. The decision was to move all the user stories and notes for the back-end Node projects to learn.
Goals:
- Creates a single source for user stories and instructions to reside.
- Makes it easier to create translations of these projects’ instructions.
- Make them easier to maintain
Tasks:
- Each user story will be a test text in the
learnfile. The user stories should be written from the second person perspective. - The description section of each
learnfile should be standardized to include a link to the demo project and to the boileplate (repl.it and github.com). Any supplemental information likes notes or examples would be incorporated in the bottom of description section. Here’s how the markdown should look:
Build a full stack JavaScript app that is functionally similar to this: <a href='https://timestamp-microservice.freecodecamp.rocks/' target='_blank'>https://timestamp-microservice.freecodecamp.rocks/</a>. Working on this project will involve you writing your code using one of the following methods:
- Clone <a href='https://github.com/freeCodeCamp/boilerplate-project-timestamp/' target='_blank'>this GitHub repo</a> and complete your project locally.
- Use <a href='https://repl.it/github/freeCodeCamp/boilerplate-project-timestamp' target='_blank'>our repl.it starter project</a> to complete your project.
- Use a site builder of your choice to complete the project. Be sure to incorporate all the files from our GitHub repo.
When you are done, make sure a working demo of your project is hosted somewhere public. Then submit the URL to it in the `Solution Link` field. Optionally, also submit a link to your project's source code in the `GitHub Link` field.
- Use the user stories with the most specificity. e.g. If the user stories are more specific on the
README.md(boilerplate or demo-project) orindex.htmlof demo project, use those on/learnfor the test text. - Each boilerplate README.md file should only contain a project title that links to the the applicable
learnpage project. Any other text should be deleted. Example:
# [URL Shortener Microservice](https://www.freecodecamp.org/learn/apis-and-microservices/apis-and-microservices-projects/url-shortener-microservice)
- Any user stories or instructions should be removed form the project code files (i.e.
myApp.jsorserver.js. - Remove any user story information from a project’s landing page (i.e.
index.html). The only thing that should remain would be example usage information. This applies to the demo projects and boilerplates.
Notes:
- The project demos are hosted in the demo-projects repo
- Please limit PR’s on
/learnto one project at a time - PR’s to boilerplates cannot be merged until changes on learn hit production.
- Once all changes have been deployed, the
README.mds for each project in thedemo-projectsrepo will be deleted. - If you would like to work on one of the projects, please reply so we can add your name to the table below, to avoid duplicate work by other contributors.
Issue Analytics
- State:
- Created 3 years ago
- Comments:34 (34 by maintainers)
Top Results From Across the Web
Best Agile User Stories and examples - KnowledgeHut
User Story is a tool in which requirements are captured in an easy to understand plain language, and is written from the perspective...
Read more >Node.js Express Tutorial: Create a User Management System
First, let's learn more about what Express. js is and then implement it in a Node. js application to create a server.
Read more >User Stories | Examples and Template - Atlassian
User stories are a few sentences in simple language that outline the desired outcome. They don't go into detail. Requirements are added later,...
Read more >Writing User Stories for Back-end Systems
I was asked recently how to go about writing user stories for a back-end financial system. This is an interesting example and is...
Read more >How To Set Up a Node.js Application for Production on ...
In this tutorial, you will set up a production-ready Node.js environment on a single Ubuntu 18.04 server. This server will run a Node.js ......
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
I believe we’ve caught them all, but just in case we missed any… an extra set of eyes to ensure there are no InfoSec related stories/tests on the QA projects would be greatly appreciated 😁
I closed #39435 to roll in to this issue.
@SaintPeter To clarify: It is not the READMEs in the boilerplates that need to be removed…it is the READMEs in the demo-projects which need to be removed.