freeCodeCamp/curriculum/challenges/english/05-apis-and-microservices/managing-packages-with-npm/add-a-license-to-your-packa...

53 lines
1.4 KiB
Markdown
Raw Normal View History

2018-10-25 18:29:56 +00:00
---
id: 587d7fb4367417b2b2512bfe
title: Add a License to Your package.json
challengeType: 2
forumTopicId: 301523
2018-10-25 18:29:56 +00:00
---
## Description
<section id='description'>
2019-03-03 18:30:44 +00:00
The <code>license</code> field is where you inform users of what they are allowed to do with your project.
Some common licenses for open source projects include MIT and BSD. License information is not required, and copyright laws in most countries will give you ownership of what you create by default. However, its always a good practice to explicitly state what users can and cant do. Here's an example of the license field:
```json
"license": "MIT",
```
2018-10-25 18:29:56 +00:00
</section>
## Instructions
<section id='instructions'>
2019-03-03 18:30:44 +00:00
Fill the <code>license</code> field in the package.json file of your project as you find suitable.
2018-10-25 18:29:56 +00:00
</section>
## Tests
<section id='tests'>
```yml
tests:
- text: package.json should have a valid "license" key
testString: 'getUserInput => $.get(getUserInput(''url'') + ''/_api/package.json'').then(data => { var packJson = JSON.parse(data); assert(packJson.license, ''"license" is missing''); }, xhr => { throw new Error(xhr.responseText); })'
2018-10-25 18:29:56 +00:00
```
</section>
## Challenge Seed
<section id='challengeSeed'>
</section>
## Solution
<section id='solution'>
```js
/**
Backend challenges don't need solutions,
because they would need to be tested against a full working project.
Please check our contributing guidelines to learn more.
*/
2018-10-25 18:29:56 +00:00
```
2018-10-25 18:29:56 +00:00
</section>