Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sparkeduab/sparked
Software for organizing and presenting educational and training content for delivery on most platforms.
https://github.com/sparkeduab/sparked
crossplatform education hacktoberfest meteorjs mongodb reactjs sparked
Last synced: about 1 month ago
JSON representation
Software for organizing and presenting educational and training content for delivery on most platforms.
- Host: GitHub
- URL: https://github.com/sparkeduab/sparked
- Owner: SparkEdUAB
- License: mit
- Created: 2017-10-09T16:13:24.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-03T15:14:27.000Z (about 2 months ago)
- Last Synced: 2024-10-14T03:41:53.150Z (about 1 month ago)
- Topics: crossplatform, education, hacktoberfest, meteorjs, mongodb, reactjs, sparked
- Language: JavaScript
- Homepage:
- Size: 7.68 MB
- Stars: 14
- Watchers: 6
- Forks: 15
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://gitpod.io/#https://github.com/SparkEdUAB/SparkEd)
# SparkEd
[](https://travis-ci.com/SparkEdUAB/SparkEd)
[](https://standardjs.com)
> Software for organizing and presenting educational and training content for delivery on most platforms.
SparkEd was deployed on a server and it loaded more than 1,500 resources. It worked very well in an office setting and was tested with 20 hosts. We plan to deploy the system in a school with more than 600 students.
To get started check out [our wiki](https://github.com/SparkEdUAB/SparkEd/wiki)
[Check here](https://sparkeduab.github.io/sparked-manual/) for the online documentation how to use this project and a small demo here https://sparkedv2.herokuapp.com/ accessible on big screens.
**Note**: We only support Node^10
# For Contributors
> Read the Code of Conduct [here](https://github.com/SparkEdUAB/SparkEd/blob/master/CODE_OF_CONDUCT.md)
The project uses the following stack
- **Meteor** as the overall framework
- **React** as the User Interface library
- **eslint** to lint files
- **Jest** for testing
- **MongoDB** as a noSql Database
### Development
if you don't have meteor run the script below
`curl https://install.meteor.com/ | sh`
### For Windows Users
Download and install `git`
Use **PowerSell** in administrator mode
> Go through the **requirements** found [here](https://chocolatey.org/install) before installing **meteorjs**
After doing the above now you can install **meteor**
`choco install meteor`
After installing **meteor** use git to clone the repo **WINDOWS USERS**
Clone the repo
`git clone https://github.com/SparkEdUAB/SparkEd.git`
`cd SparkEd`
Install dependencies
`meteor npm install` or `meteor yarn`
Run the application
`meteor`
If you have challenges with language translations, you need to set the environment variables
`export UNIVERSE_I18N_LOCALES = all`
### Contribution
Fork this repo
Clone your forked repo
`git clone https://github.com/your-github-username/SparkEd.git`
Add this repo to your remotes as upstream.
`git remote add upstream https://github.com/SparkEdUAB/SparkEd`
Before pushing anything to your fork, always
`git pull upstream master`
> Make sure your commit messages should be clear not vague e.g "Changes and Updates made"
> Work from a branch other than master whenever possible and branch name should be clear
> Write clean and transparent code which is easy to maintain
> When making PRs, give clear descriptions of the changes you made.
### Testing
`npm run test` or `yarn run test`
### linting
`npm run lint` or `yarn run lint`
Before you make commit, make sure that the linting are passing, check with the eslintrc.yml to check the rules.
## Sync
- References
- Resources
The above are all stored in MongoDB GridFS that means there is no need to access the filesystem to get images or videos, mongodb chunks them down.
⇒ The move was to facilitate the easy of moving files across servers.
⇒ Having One database for files and Data.
⇒ Easy Syncing
We have 2 scripts,
> one exports the specified database collection from the main server, it will be checking every 24 hours.
> The other scripts downloads the exported database collection from the main server, and merges the local server with new data.
Example of the script (exports chunks)
```
colls=( fs.chunks fs.files Resources References)
if [ -d "dump" ] ; then
echo "Directory exist and will be removed"
sleep 1
echo "Removing the directory"
sleep 2
rm -rf dump dump.tar.gz
fi
for coll in ${colls[@]}
do
echo $coll
# for the remote main server
mongodump -h localhost:27017 -d sparked -c $coll
done
echo "compressing the dumped directory "
tar cvzf /var/www/sparked/bundle/public/dump.tar.gz dump/
# bundle and send to the public to be downloadable (main server)
```
### Authenticating via REST Endpoint
Meteor's standard is to use the DDP between the server and client and this gives realtime that no other framework offers, but there are times when you don't need this magic and you just want to have your own client using different technologies.
We have REST endpoint implemented for critical routes and in case you want to login here is an example
```
// Here you can use either username or email for authentication
const data = { email: '[email protected]', password: '34rnf322{#998!!' };
fetch('https://localhost:3000/api/login', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify(data),
})
.then(response => response.json())
.then(data => {
// you will get the userId and authToken that you can use for other server calls
console.log('Success:', data);
})
.catch((error) => {
console.error('Error:', error);
});
```
### Deployment
**SparkEd** was meant to run in an offline environment but you are initially required to have internet to have it deployed, you can check [our wiki](https://github.com/SparkEdUAB/SparkEd/wiki) for more info on setting up a proper server.
The wiki mentioned above includes deployment as well, the guide I am going to show is to allow you to simply put up a stable server that in a shorter time.
Just like in Development mentioned [here](https://github.com/SparkEdUAB/SparkEd#development) I will assume that you have a working version of SparkEd on your local machine, you can follow the instructions mentioned above in the development to get it running.
#### Requirements
- Nodejs ˆ10
- Latest version of `npm` or `yarn`
- Access to a terminal
To get started, install `mup` (meteor-up)
**mup** allows you to deploy your meteor apps to any server and anywhere, it runs on a docker container
`npm install --global mup` or `yarn add global mup`
The above command will install `mup` globally, and it will allow you to access it anywhere in your terminal.
next run the following command
`mup init`
The above will initialize the meteor up for your project, make sure you are inside SparkEd
it creates a directory called `.deploy` which contains 2 files `mup.js` and `settings.json`
```bash
├── .deploy
│ └── mup.js
└── settings.json
```
The `mup.js` file is the one you will want to pay attention to, it contains the server information you will need to update as required
```Javascript
servers: {
one: {
host: '', // change this to the server address
username: '', // username of the server
password: '', // password for the username above
// pem: './path/to/pem', // in case you are using an ssh key
},
},
app: {
name: 'SparkEd', // name of the app is SparkEd
path: '../', // Specify the location of the app, used ../ because we are in .deploy directory
env: {
ROOT_URL: '', // this is server address of where you are deploying to, it can be a local IP of the server you are deploying to
MONGO_URL: 'mongodb://mongodb/meteor',
MONGO_OPLOG_URL: 'mongodb://mongodb/local',
},
```
Double check to make sure that your details are correct, if something doesn't work, kindly create an issue to let us know
run the following command to get the setup meteor up
`mup setup`
The above command might take a while, make sure you have a good internet and just wait for it, when it is done run the following command
`mup deploy`
The above command will deploy SparkEd on the specified server address
Make sure you read more info [here](http://meteor-up.com) on meteor-up
### Docker
To run the current image built
`docker pull olivierjm/spark`
and run it as specified [here](#running-the-image)
#### Build an image
You can build a docker image in 2 ways
- You can use the provided `launchpad.conf` file
`docker build -t yourname/sparked:tag .`
- You can use build args to pass args when building the image
```bash
docker build \
--build-arg APT_GET_INSTALL="curl git wget" \
--build-arg INSTALL_MONGO=true \
--build-arg NODE_VERSION=8.11.4 \
-t yourname/sparked:tag .
```
The above will install mongodb and meteor will use that instance to run but If you are building for production it is best to use an external mongodb, you provide a url when run the built image.
#### Running the image
In the normal way you would run the image as follows
`docker run imagename:tag`
but we need to provide environment vairables that meteor can pick up and use like **_ROOT_URL_**, **_PORT_**, **_MONGO_URL_** and any other envs that you might want to pass along.
If you are using an external mongodb then you can provide the link to connect to when running the image.
```bash
docker run -d \
-e ROOT_URL=http://your_url \
-e MONGO_URL=mongodb://url:dbname \
-e MONGO_OPLOG_URL=mongodb://oplog_url \
-p 80:3000 \
yourname/sparked:tag
```
If you set `INSTALL_MONGO` to true when building the image or in the `launchpad.conf` then you don't need to set the _MONGO_URL_
```bash
docker run -d \
-e ROOT_URL=http://your_url \
-p 80:3000 \
yourname/sparked:tag
```
check `http://your_url` in your browser if the image run successfully then you should be able to have everything workin.
### Issues
Check [here](https://github.com/SparkEdUAB/SparkEd/issues) for issues, urgent issues that need attention are pinned on top of other issues. feel free to file an issue if you are experiencing a problem or dive in the existing ones to contribute.
### Contributors
We acknowledge contributors who added value to this project in any way.
