camilocoo / main-documentation

This repository servers like an aggregator everything that is being developed and publish in breathecode.

Welcome to BreatheCode

Hello, my name is 😊 Alejandro Sanchez I'm the founder of BreatheCode, thank you for taking the time to read this! 😄

BreatheCode's mission is to accelerate the way junior developers learn and evolve using technology.

BreatheCode's code is divided in 4 main verticals:

• Tools: Stuff you can download and use to learn how to build software faster.
• Libraries: Some libraries targeted to fix recurrent coding challenges like: Session Management, Notifications, etc.
• Apps: We build software for teaching purposes only.
• APIs: Assets for teachers.

Thanks to the breathecode-cli we where able to include a set of recommended boilerplates to bootstrap projects in different technologies.

If you want to learn more about our current projects and developments look at the end of the document.

Are you here to contribute?

Great! You can contribute to BreatheCode in four different ways:

• BreatheCode Coder: Join the development of any particular project, the majority of our repositories are being actively maintain and with new versions on the pipeline. Read this if you want to become a BreatheCode Coder.
• BreatheCode Writer: Help us explain everything to the community: What projects are available? how do they work? how to use them? Here is a more detailed guide you should read if you want to become a BreatheCode Writer.
• BreatheCode Inspector: Report issues you find on the application or any improvements you would like. Here is how to report a bug or request a new feature on any of BreatheCode projects.
• BreatheCode Fixer: There are a lot of issues revolving around our libraries, it is really hard fix them all and more keep showing up 😥 Here is a small guide on how to help us solve bugs!

Our current projects

These are the 4 types of projects in which the BreatheCode is divided:

1. Tools

In real life you use a lot of tools to code, like: Git, NPM, etc. We have proposed 2 additional tools for junior developers:

Project	Description	Technologies
C9 Plugin	Cloud 9 is a great IDE for junior developers because it allow you to work with very few configurations no an isolated machine. We have created a plugin to enhance the Cloud 9 coding IDE and integrated with all the other BreatheCode projects.	Node.js, Bash, JSON
BreatheCode CLI	Command Line interface to connect with lots of useful stuff like access to boilerplates, exercises, builders, etc.	Node.js Bash, JSON

2. Libraries:

Very focused libraries to resolve recurring issues during developments.

Project	Description	Technologies
vReact Session	Allows persistent sessions in react, compatible with react router.	React.js
React Notifier	Notification library for React Applications.	React.js
React Flux Dash	Flux implementation for React.js	React.js

3. Applications:

Project	Description	Technologies
CMS	This is were most of the community content is being published: Lessons, Error Explanations and "How to's".	Gatsby.js, CSS, React.js, Markdown, GIT
Student Web Client	BreatheCode's main website for displaying the courses.	React.js, CSS, Sass, HTML
Teacher Web Client	Teachers are able to manage the pace of their cohorts, review students deliverables, etc.	React.js, CSS, Sass, HTML
Admin Web Client	Manage BreathCode students, teachers, etc.	React.js, CSS, Sass, HTML

4. API's:

Project	Description	Technologies
Platform API	The API for the LMS, it manages students, courses, etc.	EloquentORM, PHP, SlimPHP, MySQL, JSON, REST
Assets API	Amazing resources for students (infographics, lessons, cheat-sheets, mock api's, etc).	PHP, Markdown, SlimPHP, SQLite, MySQL, Static Files, REST