Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "next/core-web-vitals"
}
37 changes: 26 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,20 +1,35 @@
# Dependencies
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# Production
/build
# testing
/coverage

# Generated files
.docusaurus
.cache-loader
# next.js
/.next/
/out/

# production
/build

# Misc
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
172 changes: 129 additions & 43 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,129 @@
St. Jude Children's Research Hospital Genomics Guide License

Copyright © 2022 St. Jude Children's Research Hospital

Permission is hereby granted, free of charge, to read, use, copy, download, and
edit this Guide, and to permit persons to whom the Guide is furnished to do so,
subject to the following conditions:

1. Identification of St. Jude Children’s Research Hospital, Inc., as the owner
of the copyright and the author of the material. This permission notice
shall be included in all copies or substantial portions of the Guide.

2. You do not publish the Guide or offer it for sale.

3. This Guide is written specifically by and for computer scientists and
engineers. The underlying biology in cancer genomics can be exceedingly
complex and requires years of study. Making the content palatable requires
drawing abstractions around these concepts. This guide should be treated as
an introduction to the domain that teaches our audience the material in a
"broad-strokes" fashion. Please be forgiving if you feel we have glossed over
your favorite quirk of cancer genomics. Further, everything within the guide
is presented within a research context and may not be relied on in making
decisions about patients. If you feel anything has been stated incorrectly,
you can file an issue on the GitHub repository.

4. THE GUIDE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE GUIDE OR THE USE OR RELIANCE ON THE GUIDE OR
ANY STATEMENTS CONTAINED IN IT. THE AUTHORS AND COPYRIGHT HOLDER ASSUME NO
LIABLITY FOR RELIANCE ON THE GUIDE. BY USING THE GUIDE, YOU WAIVE ANY CLAIMS
AGAINST THE AUTHORS AND COPYRIGHT HOLDERS RELATED TO THE CONTENT OF OR
ACCESS TO THE GUIDE. IF SUCH WAIVER IS NOT LAWFUL, THE USER AGREES THAT THE
LIABLITY OF THE AUTHORS AND COPYRIGHT HOLDER IS LIMITED TO THE AMOUNT THE
USER PAID FOR THE GUIDE.

5. If you make any additions or edits (“Contributions”) to the Guide, you grant
the authors and copyright holder an irrevocable, perpetual, world-wide,
no-charge, royalty-free, non-exclusive license to use those Contributions.
You further represent that each of your Contributions is an original creation
not subject to copyright of any third party.
# Tailwind Plus License

## Personal License

Tailwind Labs Inc. grants you an on-going, non-exclusive license to use the Components and Templates.

The license grants permission to **one individual** (the Licensee) to access and use the Components and Templates.

You **can**:

- Use the Components and Templates to create unlimited End Products.
- Modify the Components and Templates to create derivative components and templates. Those components and templates are subject to this license.
- Use the Components and Templates to create unlimited End Products for unlimited Clients.
- Use the Components and Templates to create End Products where the End Product is sold to End Users.
- Use the Components and Templates to create End Products that are open source and freely available to End Users.

You **cannot**:

- Use the Components and Templates to create End Products that are designed to allow an End User to build their own End Products using the Components and Templates or derivatives of the Components and Templates.
- Re-distribute the Components and Templates or derivatives of the Components and Templates separately from an End Product, neither in code or as design assets.
- Share your access to the Components and Templates with any other individuals.
- Use the Components and Templates to produce anything that may be deemed by Tailwind Labs Inc, in their sole and absolute discretion, to be competitive or in conflict with the business of Tailwind Labs Inc.

### Example usage

Examples of usage **allowed** by the license:

- Creating a personal website by yourself.
- Creating a website or web application for a client that will be owned by that client.
- Creating a commercial SaaS application (like an invoicing app for example) where end users have to pay a fee to use the application.
- Creating a commercial self-hosted web application that is sold to end users for a one-time fee.
- Creating a web application where the primary purpose is clearly not to simply re-distribute the components (like a conference organization app that uses the components for its UI for example) that is free and open source, where the source code is publicly available.

Examples of usage **not allowed** by the license:

- Creating a repository of your favorite Tailwind Plus components or templates (or derivatives based on Tailwind Plus components or templates) and publishing it publicly.
- Creating a React or Vue version of Tailwind Plus and making it available either for sale or for free.
- Create a Figma or Sketch UI kit based on the Tailwind Plus component designs.
- Creating a "website builder" project where end users can build their own websites using components or templates included with or derived from Tailwind Plus.
- Creating a theme, template, or project starter kit using the components or templates and making it available either for sale or for free.
- Creating an admin panel tool (like [Laravel Nova](https://nova.laravel.com/) or [ActiveAdmin](https://activeadmin.info/)) that is made available either for sale or for free.

In simple terms, use Tailwind Plus for anything you like as long as it doesn't compete with Tailwind Plus.

### Personal License Definitions

Licensee is the individual who has purchased a Personal License.

Components and Templates are the source code and design assets made available to the Licensee after purchasing a Tailwind Plus license.

End Product is any artifact produced that incorporates the Components or Templates or derivatives of the Components or Templates.

End User is a user of an End Product.

Client is an individual or entity receiving custom professional services directly from the Licensee, produced specifically for that individual or entity. Customers of software-as-a-service products are not considered clients for the purpose of this document.

## Team License

Tailwind Labs Inc. grants you an on-going, non-exclusive license to use the Components and Templates.

The license grants permission for **up to 25 Employees and Contractors of the Licensee** to access and use the Components and Templates.

You **can**:

- Use the Components and Templates to create unlimited End Products.
- Modify the Components and Templates to create derivative components and templates. Those components and templates are subject to this license.
- Use the Components and Templates to create unlimited End Products for unlimited Clients.
- Use the Components and Templates to create End Products where the End Product is sold to End Users.
- Use the Components and Templates to create End Products that are open source and freely available to End Users.

You **cannot**:

- Use the Components or Templates to create End Products that are designed to allow an End User to build their own End Products using the Components or Templates or derivatives of the Components or Templates.
- Re-distribute the Components or Templates or derivatives of the Components or Templates separately from an End Product.
- Use the Components or Templates to create End Products that are the property of any individual or entity other than the Licensee or Clients of the Licensee.
- Use the Components or Templates to produce anything that may be deemed by Tailwind Labs Inc, in their sole and absolute discretion, to be competitive or in conflict with the business of Tailwind Labs Inc.

### Example usage

Examples of usage **allowed** by the license:

- Creating a website for your company.
- Creating a website or web application for a client that will be owned by that client.
- Creating a commercial SaaS application (like an invoicing app for example) where end users have to pay a fee to use the application.
- Creating a commercial self-hosted web application that is sold to end users for a one-time fee.
- Creating a web application where the primary purpose is clearly not to simply re-distribute the components or templates (like a conference organization app that uses the components or a template for its UI for example) that is free and open source, where the source code is publicly available.

Examples of use **not allowed** by the license:

- Creating a repository of your favorite Tailwind Plus components or template (or derivatives based on Tailwind Plus components or templates) and publishing it publicly.
- Creating a React or Vue version of Tailwind Plus and making it available either for sale or for free.
- Creating a "website builder" project where end users can build their own websites using components or templates included with or derived from Tailwind Plus.
- Creating a theme or template using the components or templates and making it available either for sale or for free.
- Creating an admin panel tool (like [Laravel Nova](https://nova.laravel.com/) or [ActiveAdmin](https://activeadmin.info/)) that is made available either for sale or for free.
- Creating any End Product that is not the sole property of either your company or a client of your company. For example your employees/contractors can't use your company Tailwind Plus license to build their own websites or side projects.

### Team License Definitions

Licensee is the business entity who has purchased a Team License.

Components and Templates are the source code and design assets made available to the Licensee after purchasing a Tailwind Plus license.

End Product is any artifact produced that incorporates the Components or Templates or derivatives of the Components or Templates.

End User is a user of an End Product.

Employee is a full-time or part-time employee of the Licensee.

Contractor is an individual or business entity contracted to perform services for the Licensee.

Client is an individual or entity receiving custom professional services directly from the Licensee, produced specifically for that individual or entity. Customers of software-as-a-service products are not considered clients for the purpose of this document.

## Enforcement

If you are found to be in violation of the license, access to your Tailwind Plus account will be terminated, and a refund may be issued at our discretion. When license violation is blatant and malicious (such as intentionally redistributing the Components or Templates through private warez channels), no refund will be issued.

The copyright of the Components and Templates is owned by Tailwind Labs Inc. You are granted only the permissions described in this license; all other rights are reserved. Tailwind Labs Inc. reserves the right to pursue legal remedies for any unauthorized use of the Components or Templates outside the scope of this license.

## Liability

Tailwind Labs Inc.’s liability to you for costs, damages, or other losses arising from your use of the Components or Templates — including third-party claims against you — is limited to a refund of your license fee. Tailwind Labs Inc. may not be held liable for any consequential damages related to your use of the Components or Templates.

This Agreement is governed by the laws of the Province of Ontario and the applicable laws of Canada. Legal proceedings related to this Agreement may only be brought in the courts of Ontario. You agree to service of process at the e-mail address on your original order.

## Questions?

Unsure which license you need, or unsure if your use case is covered by our licenses?

Email us at [[email protected]](mailto:[email protected]) with your questions.
54 changes: 37 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,50 @@
<p align="center">
<a href="https://github.com/learngenomics/learngenomics.dev">
<img src="https://github.com/learngenomics/learngenomics.dev/raw/main/.github/assets/github-readme-header.png" width="800" title="Learn Genomics README header"></a>
</a>
</p>
# Learn Genomics (Redesign)

[Learn Genomics] is a guide that aims to introduce the subject of genomics to software engineers and data scientists in a palatable, straightforward manner. It was originally written by software engineers at St. Jude Children's Research Hospital, and now it has grown to a community-maintained project.

### Quickstart
This redesigned version is built using [Next.js](https://nextjs.org), [Tailwind CSS](https://tailwindcss.com), and [MDX](https://mdxjs.com/), providing a modern, performant, and accessible learning experience.

The guide is built on top of [Docusaurus 2] with some simple, custom theming added on top.
If you wish to build the guide locally, you can run the following commands:
## Getting started

```bash
# install the dependencies needed
$ npm install
To get started with this redesign, first install the npm dependencies:

# run a livereloading site
$ npm start
```bash
npm install
```

If you wish to build a static version of the site, you can do the following:
Next, run the development server:

```bash
# build a static version of the site in the build/ directory.
$ npm run build
npm run dev
```

Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.

## Customizing

You can start editing this site by modifying the files in the `/src` folder. The site will auto-update as you edit these files.

## Global search

This site includes a global search powered by the [FlexSearch](https://github.com/nextapps-de/flexsearch) library. It's available by clicking the search input or by using the `⌘K` shortcut.

This feature requires no configuration and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the `/src/mdx/search.mjs` file.

## Learn more

To learn more about the technologies used in this site, see the following resources:

- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
- [MDX](https://mdxjs.com/) - the official MDX documentation
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation

---

**Note:** This redesign is based on the [Protocol](https://tailwindcss.com/plus) site template from Tailwind Plus. The Protocol template is a commercial product licensed under the [Tailwind Plus license](https://tailwindcss.com/plus/license).

[Learn Genomics]: https://learngenomics.dev
[Docusaurus 2]: https://docusaurus.io/
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

4 changes: 0 additions & 4 deletions docs/01-biological-foundations/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docs/02-genomic-variation/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docs/03-next-generation-sequencing/_category_.json

This file was deleted.

Loading