SocialCircle is a social networking platform where users can create posts, like and comment on them, and connect with other users.
To get started with the project, you can follow these steps:
-
Clone the repository:
git clone -
Install the dependencies:
npm install / yarn install -
Create a
.env
file in the root directory of the project with the following contents:
SERVER_PORT=8080
JWT_SECRET_KEY=mysecretkey
NODE_ENV=dev
DATABASE_URL=your_db_connection_string_here -
Start the server:
npm run start:dev
The server will start on port 8080
.
The following endpoints are available in the project:
POST /api/v1/users/register
: Register a new user.POST /api/v1/users/login
: Login a user.
GET /api/v1/users/me
: Get the profile of a user.PUT /api/v1/users/me
: Update the profile of a user.DELETE /api/v1/users/me
: Delete the profile of a user.
POST /api/v1/posts/create
: Create a new post.DELETE /api/v1/posts/delete/:postId
: Delete a post.PUT /api/v1/posts/update/:postId
: Update a post.GET /api/v1/posts/my-posts
: Get the posts of the authenticated user.
POST /api/v1/posts/like/:postId
: Like a post.
The following technologies were used in the project:
- Node.js
- Express.js
- Typescript
- Prisma ORM
- PlanetScale MySQL
This project is licensed under the MIT License.