Skip to content

Application for Working parents monitor their children study progress and making lessons plans for them.

Notifications You must be signed in to change notification settings

aang13/kid-wise

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Overview: This webapp allows creating Lesson plan for children by their parents. It's of great use to the parents who work outside home to monitor, assess their children's study progress. Types of Users:

  1. Parent User
  2. Children User

Flow of action:

  1. Parent users can create profile for children user.
  2. Parent user can create lesson plan for their children.
  3. Creating a lesson plan includes creating Standard -> creating Subject -> creating Chapters-> Creating lessons -> creating topics.
  4. Parents can add quiz, exams for their children as well.

Requirements
for building and running the application you need:
JDK 11
Maven 3

Running the application locally
You can use any IDE that support Spring Boot applications and run from there.
Alternatively you can use Spring Boot maven plugin like so:
mvn spring-boot:run

Once the application is run you can access all the Rest end points via swagger. To see the full list of apis run the project & browse: http://localhost:8080/swagger-ui.html

Here are the list of apis. alt text

Database
H2 database: in memory database for spring boot application.Note that the in-memory database is volatile, and data will be lost when we restart the application.

Dockarize the application
create an executable jar file:
mvn clean package

start up the Spring Boot application:\

java -jar target/kid-wise-0.0.1-SNAPSHOT.jar

Create Docker image from docker file:
docker build --tag=kid-wise:latest .

Run the docker image:
docker run -p8080:8080 kid-wise:latest

Using Docker-compose:
Build: docker-compose build
Run: docker-compose up -d
Stop: docker-compose down

About

Application for Working parents monitor their children study progress and making lessons plans for them.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published