Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Note
This project was created as a submission for BCC's Backend Department Internship Program (2024). It marks the beginning of my journey into JavaScript and backend development. I acknowledge that this project has several flaws and areas for improvement—for example, it lacks proper abstraction, does not use TypeScript, and has no rate limiting in place. I plan to remake this project in a cleaner, more robust version using Typescript, with better architectural structure and additional features.
Schofinity is a platform that provides scholarship information and assists users in preparing to apply for scholarships through various programs such as Bootcamp, Workshops, and Mentoring.
The Schofinity platform provides many API products, tools, and resources that enable you to:
- Get comprehensive scholarship information
- Adding scholarships to favorites
- Offering scholarships Timeline + Reminder features
- Displaying scholarships based on categories
- Filtering scholarships to be displayed when searched
- Assisting in preparing for scholarships (Bootcamp, Workshops, Mentoring)
To start using our API you can either simply use existing deployed API in the url provided below or following installation steps.
API Base URL: https://schofinity-c284f28bf9dd.herokuapp.com/v1/. Please follow our documentation provided at the end of this document for further information about how to user our API. If you wish to use this API on your own server, you can follow instruction step provided below.
Before you continue to installation step, there is a few things you may need to configure first. This API requires you to configure:
- MySQL Database
- Supabase Storage
- Gmail SMTP
- Midtrans
git clone https://github.com/yogarn/schofinity.git cd schofinity npm i
After configuring supabase, Gmail smtp, and midtrans, you need to create .env file. You can also just rename existing .env.example in root folder to .env. Then, you need to fill all the empty field in that example file. If you left one of the field empty when it not supposed to, the server may crash immediately.
Make sure you already have sequelize-cli installed in your machine. You can install it by npm i sequelize-cli. You also need to create a database and configure it in your .env file, otherwise, the migration step below won't work at all.
npx sequelize-cli db:migrate npx sequelize-cli db:seed:all
After completing all the required step above, you can run the server by following instruction below.
npm start
If you want to start your API under development mode, you can start it using nodemon by executing the following command.
npm run dev
For further information about our API and its features, you can visit this postman documentation.