https://github.com/bebatut/black-science-edu
https://github.com/bebatut/black-science-edu
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bebatut/black-science-edu
- Owner: bebatut
- License: mit
- Created: 2018-11-11T08:14:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-11T20:50:12.000Z (over 7 years ago)
- Last Synced: 2025-02-08T04:18:28.906Z (over 1 year ago)
- Language: CSS
- Homepage: http://bebatut.fr/black-science-edu/
- Size: 2.69 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Black Science Education
=======================
Bring science to the public!
Gitter channel?
# Welcome!
First and foremost, Welcome! 🎉 Willkommen! 🎊 Bienvenue! 🎈🎈🎈
This document (the README file) is a hub to give you some information about the project. Jump straight to one of the sections below, or just scroll down to find out more.
# What are we doing?
We are working with teachers, educators and citizens to educate the public about open science and particularly with sequencing, data-analysis, molecular biology, their benefits and implications.
# Who are we?
The members of the Black Science Education group are scientists from the [University of Freiburg](https://www.uni-freiburg.de/).
# What do we need?
**You!** In whatever way you can help.
We need expertise in fundraising, science, education, communication, interaction with the public. We'd love your feedback along the way, and of course.
# Get involved
If you think you can help in any of the areas listed above (and we bet you can) or in any of the many areas that we haven't yet thought of (and here we're sure you can) then please check out [our contributors' guidelines](CONTRIBUTING.md) and our [roadmap](roadmap.md).
Please note that it's very important to us that we maintain a positive and supportive environment for everyone who wants to participate. When you join us we ask that you follow our [code of conduct](CODE_OF_CONDUCT.md) in all interactions both on and offline.
# How can I generate the website locally?
1. Open a Terminal
2. (If not done yet) Clone the training material GitHub repository with `git clone https://github.com/bebatut/black-science-edu.git`
3. Navigate to the `black-science-edu/` folder with `cd`
4. Set up the conda environment
It will install some needed tools (ruby, nodejs, etc) in a protected environment, without interfering with the existing tools or versions.
1. Install conda (if not already installed): `make install-conda`
2. Create the `black_science_edu` conda environment: `make create-env`
4. Install Jekyll and related modules into the conda environment: `make install`
If you encounter an error about libxml2 on Linux, please try to install `libxml2-dev` (executing `sudo apt install libxml2-dev`) if on Debian/Ubuntu or `libxml2-devel` (executing `sudo yum install libxml2-devel`) if on Fedora/RedHat/CentOS, and re-run `make install` .
5. Run a local Jekyll server with `make serve`
6. Visualize at [http://localhost:4000/black-science-edu/ ](http://localhost:4000/black-science-edu/)