Skip to content

Moliki-Salman/development-tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Development-tracker

Development-tracker is an API that allows Users the ability to actively track and improve their child's developmental journey.

The project is written with Javascript using express Node.js application framework and MySQL as the database.

Features

  1. User can signup and login to their account.

  2. User can reset their password.

  3. User account activated using JSON web token authenitcation.

  4. User password is encrypted for security.

  5. Authorized User can create an account for multiple children to enable them to be able to use the tenderCare development tracker.

Getting started

  1. Install node from the website and download node for your device type:
$  https://nodejs.org/en
  1. Install MySQL locally
$ https://dev.mysql.com/downloads/mysql/
  1. Clone this repository and run locally
https://github.com/Moliki-Salman/development-tracker.git
  1. Run this code to download the projects' dependencies
 npm install
  1. Set your desired Port number in your .env file

  2. Get your personal openai API key and set it in the project .env file.

$ https://platform.openai.com/api-keys 
  1. Start the application by running:
$ nodemon app.js 
  1. Connect the API using postman on the desired port set in the project .env file.

Hosting

The app is availabe on render hosting service

$ https://development-tracker.onrender.com

API Endpoints

| HTTP Verbs | Endpoints | Action |
| --- | --- | --- |
1. | POST | /signup | To sign up a new user account |
2. | POST | /login | To login an existing user account |
3. | POST | /resetPassword | To allow user to reset password |
4. | POST | /child | To create a child profile under a user account | 
5. | POST | /tracker | To allow user to interact with the development tracker | 

License

This project is available for use under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published