Start Your Lab

A platform for labs learning how to get started with best practices and digital collaboration tools.
Explore the site »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Roadmap
3. Contributing
   • Prerequisites
   • Installation
4. Code of Conduct
5. License
6. Contact
7. Acknowledgments

About The Project

Start Your Lab is an open-source initiative to teach academic research labs how to leverage modern tools and support them with industry best practices.

Built With

• Docusaurus 2

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. As an overview, the process for contributions is as follows:

1. Fork the project
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a pull request for review
6. Approved pull requests will be merged into the main project

To get started as a contributor to Start Your Lab's docs or blog, follow the detailed steps below.

Prerequisites

You must have the Node, NPM, and Yarn command line tools installed on your local machine in order to contribute to this project.

Please see Yarn's installation guide.

Installation

This website is built using Docusaurus 2, a modern static website generator. For the best developer experience, we suggest cloning this repository to your local computer. Once you have cloned the repository, navigate into it and run the following from the root of the repository.

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Local Server Test

yarn serve

Code of Conduct

Start Your Lab is committed to fostering a welcoming community.

View our Code of Conduct for our GitHub organization.

License

Distributed under the MIT License. See LICENSE.md for more information.

Contact

Start Your Lab - @startyourlab - [email protected]

Project Link: https://github.com/startyourlab/website

Acknowledgments

• Best README Template
• Freepik
• React TypeScript Particles