Studybites is an open-source Education Platform (LMS) focused on microlearning and mobile-centric design.
There is only one way to eat an elephant, a bite at a time.
Desmond Tutu
⚙️ Local setup
Development is currently in a very early stage. The solution isn't ready to be used in a production environment.
# clone the StudyBites repository
git clone https://github.com/LambdaBird/studybites.git
# run the development version
./studybites.sh start-dev
# run the headless version
./studybites start-headless
# append latest migrations
./studybites.sh migrate
# run tests
./studybites.sh test
# remove containers
./studybites.sh down-dev
# add test users
yarn --cwd ./api seed:run
<!-- rename the .env-example -->
mv .env-example .env
<!-- and add credentials for the storage -->
<!-- add storage to your hosts file -->
sudo -- sh -c "127.0.0.1 s3 >> /etc/hosts"
Create an .env file locally. You can duplicate .env-example and name the new copy .env. Adapt the variables to your needs.
SB_SEND_MAIL_STATUS=1
# 1 - Don't send email and only log it to console
# 2 - Don't log to console and only send email
# 3 - Log to console and send email
[email protected] # Email address which from message will be sent
SB_MAIL_PASSWORD=your_password # Email address password
[email protected] # Super admin account email address
SB_ADMIN_PASSWORD=some_hard_admin_password # Super admin email address password
# PostgreSQL development database name
POSTGRES_DB=studybites
# PostgreSQL test database name
POSTGRES_TEST_DB=studybites-test
# PostgreSQL username
POSTGRES_USER=sb-admin
# PostgreSQL password
POSTGRES_PASSWORD=sb-password
# Backend port
API_PORT=3017
# StudyBites admin email
[email protected]
# StudyBites admin password
SB_ADMIN_PASSWORD=passwd3
# JSON Web Token secret
JWT_SECRET=tvXqYGduhyMw28EzyBxaGrFP8zQsmRG93GZHrmADmHsU9WwB7nbULUsJ98aAqWzM
# PostgreSQL DSN for the development database
POSTGRES_URI=postgres://sb-admin:sb-password@db:5432/studybites
# PostgreSQL DSN for the test database
POSTGRES_TEST_URI=postgres://sb-admin:sb-password@db:5432/studybites-test
# Frontend port
FRONT_PORT=3018
Go to http://localhost:3018 and enter your SB_ADMIN_EMAIL and SB_ADMIN_PASSWORD you've set upper.
🤝 Contributing
PR's are welcome
Found a Bug ? Create an Issue.
For any questions and inquiries not related to code, please write to [email protected]