Intra Butter School
IBS is an Open Source project : it consists in building a community platform allowing students of the same class to create a group through an OAuth2 connection via Facebook and thus be able to take classes simultaneously, share documents, consult their planning, configure reminders (control, duty, ...).
We are eager to add some gammification into the project, to make it fun using it (not like regular schools ERP's ;) ). Moreover, fluidity, evolution and userExperience is our motto !
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. This project use the following techologies :
- Angular 6
- Nodejs
- Angular PrimeNg
- SemanticUI
- Firebase
- SocketIO
https://intrabutterschool.firebaseapp.com Mirror of this git master branch.
Wanna join the ButterCorp Community :
Become a slack member :
Become a discord member :
[FR] Rejoindre la communauté FR :
Groupe Facebook Circle pour posez vos questions etc : lien vers la communauté Facebook FR
Prerequisites and Installation
What things you need to install the software and how to install them :
Node :
Before anything else you have to install node.js on your machine, you can check by typing
node -v
If the command is not recognized : You can download node here
NPM :
NPM is mandatory to run this project, because we are using @AngularCLI and other NPM packages for dependencies. You can check NPM install through this following command in your favorite terminal:
npm -v
If the version doesn't comes out of the terminal you can install NPM through the link below : https://www.npmjs.com/get-npm
Cloning and running the project
This project was generated with Angular CLI version 6.0.5.
Step 1: Clone this repository
git clone git@github.com:ButterCorp/intrabutterschool-front.git
and
cd intrabutterschool
Step 2: Install Angular/CLI
npm install -g @angular/cli
Step 3: Run the following command
npm install
Step 4: Angular Launch :
Run ng serve for a dev server or ng serve --open (--open opens your favorite browser (Chrome ? <3) with the right PORT). Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
Code scaffolding
Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.
Build
Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
Running unit tests
Run ng test to execute the unit tests via Karma.
Running end-to-end tests
Run ng e2e to execute the end-to-end tests via Protractor.
Further help
To get more help on the Angular CLI use ng help or go check out the Angular CLI README.
Authors
- Butter Corporation - The Butter Company - ButterCorp
Names and statements :
Kevin Gilibert : The Codacy / Code Review / Amazing Pull requester from Paris Suburbs.
Robin Thorel : Carrying the project with his front skills. Co-founder of the ButterCorporation.
Younes Diouri : Back-end crazy/lazy BOI.
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details