Skip to content

sercantor/ktu_sosyal_api

Repository files navigation

NodeJS API for KTU social media app. Major dependencies:

 Express
 
 ts-node

 For authentication/sessions, Jwt

 PostgreSQL and TypeORM

 phantom for headless web browser for web scraping

In the future, I hope to;

  • Make the codebase more readable, there are still some files where controllers have business logic
  • Implement socket.io or a message broker like kafka
  • Extend on role structure

To run the project, use docker-compose to get the database up and running, by executing

docker-compose up -d

In the project root. Then make sure your database is configured correctly;

docker exec -it postgres_db psql -U postgres -d ktu_sosyal

Or, make sure you're running a postgreSQL database on your local machine, then create an ormconfig.json file. Here's an example below:

{
  "type": "postgres",
  "host": "localhost",
  "port": 5432,
  "username": "postgres",
  "password": "<YOUR PASSWORD>",
  "database": "<YOUR DATABASE NAME>",
  "synchronize": true,
  "entities": ["src/entities/**/*.ts", "dist/entities/**/*.js"]
}

Then, run

npm install

npm run start

and the API should be up and running.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published