Make company global travel and accommodation easy and convenient for the strong workforce of savvy members of staff, by leveraging the modern web.
This is the swagger API documentation link
This the heroku staging Api https://script-heroes-bn-backend-stgng.herokuapp.com/
This the production Api https://script-heroes-bn-backend.herokuapp.com/
- Create .env file in project root directory
- Copy keys in .env-example file, which is in the project root directory and assign values to those keys.
- You can add more environmenta variables to the .env file
- To use declared variables, require dotenv at the top of your file
import dotenv from 'dotenv'
and call its method configdotenv.config()
- Access environment variable value by using
process.env.KEY_NAME
whereKEY_NAME
is the variable name.
Note: If you make changes that uses environmental variables make sure to add those variables with example values in the .env.example file.
npm install
sequelize db:migrate
sequelize db:seed:all
{
"firstName": "name",
"lastName": "lastName",
"email": "[email protected]",
"phoneNumber": "12345678",
"password": "mypassword"
}
{
"email": "[email protected]"
}
{
"password": "newPassword",
"confirmPassword": "newPassword"
}
{
gender: DataTypes.STRING,
birthdate: DataTypes.DATE,
language: DataTypes.STRING,
currency: DataTypes.STRING,
country: DataTypes.STRING,
department: DataTypes.STRING,
linemanager: DataTypes.INTEGER
}
{
firstName: DataTypes.STRING,
lastName: DataTypes.STRING,
phoneNumber: DataTypes.STRING,
gender: DataTypes.STRING,
birthdate: DataTypes.DATE,
language: DataTypes.STRING,
currency: DataTypes.STRING,
country: DataTypes.STRING,
department: DataTypes.STRING,
linemanager: DataTypes.INTEGER
}
{
"firstName": "name",
"lastName": "lastName",
"email": "[email protected]",
"phoneNumber": "12345678",
"gender": "Male",
"birthdate": "1978-05-04T00:00:00.000Z",
"language": "Kinyarwanda",
"currency": "US$",
"country": "Rwanda",
"department": "IT",
"linemanager": "JOHN Doe"
}
{
"facilityName": "facility Name",
"locationId": 1,
"description": "Full description of the facility",
"roomType": "room type",
"photoUrl": "Url for image"
}
{
"origin": 1,
"destination": 3,
"from": "2020-10-10",
"till": "2020-10-15",
"travelReasons": "vacation",
"accomodationId": 1
}
- Hosted url: https://script-heroes-bn-backend-stgng.herokuapp.com/
- Signup:
/api/auth/signup
- Login:
/api/auth/login
- Complete Profile:
/api/profile/complete
- Display Profile:
/api/profile
- Update Profile:
/api/profile/update
- Accomodations:
/api/accomodations
- Forgot Password:
/api/forgotPassword
- Trip With Return Date:
/api/trip/return-trip