# algorithm-lovers

> Social network for algorithm lovers

Latest version **0.2.1** (published 2023-05-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install algorithm-lovers
pnpm add algorithm-lovers
yarn add algorithm-lovers
bun add algorithm-lovers
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2023-05-13 |
| First published | 2023-04-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 14.8 MB |
| Known vulnerabilities | 0 (+29 in 3 direct dependencies) |
| Install scripts | no |
| Author | Chen Guan |
| Maintainers | nehcg |

## Links

- npm: https://www.npmjs.com/package/algorithm-lovers
- npm.io page: https://npm.io/package/algorithm-lovers

## Dependencies (10)

- [axios](https://npm.io/package/axios.md) ^0.21.0
- [client](https://npm.io/package/client.md) file:client
- [config](https://npm.io/package/config.md) ^3.3.3
- [express](https://npm.io/package/express.md) ^4.17.1
- [bcryptjs](https://npm.io/package/bcryptjs.md) ^2.4.3
- [gravatar](https://npm.io/package/gravatar.md) ^1.8.1
- [mongoose](https://npm.io/package/mongoose.md) ^5.11.8
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^8.5.1
- [normalize-url](https://npm.io/package/normalize-url.md) ^5.3.0
- [express-validator](https://npm.io/package/express-validator.md) ^6.8.1

## Recent versions

- 0.2.1 (latest) — 2023-05-13
- 0.2.0 — 2023-05-05
- 0.1.0 — 2023-04-03

## README

# Algorithm Lovers
A web platform to share and discuss algorithms.

[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/nehCG/algorithm-lovers/blob/main/LICENSE)
[![Build Status](https://github.com/nehCG/algorithm-lovers/workflows/Build%20Status/badge.svg?branch=main)](https://github.com/nehCG/algorithm-lovers/actions?query=workflow%3A%22Build+Status%22)
[![](https://img.shields.io/github/issues/nehCG/algorithm-lovers)](https://github.com/nehCG/algorithm-lovers/issues)
[![codecov](https://codecov.io/gh/nehCG/algorithm-lovers/branch/main/graph/badge.svg)](https://codecov.io/gh/nehCG/algorithm-lovers)
[![npm](https://img.shields.io/npm/v/algorithm-lovers)](https://www.npmjs.com/package/algorithm-lovers)
[![Github Pages](https://img.shields.io/badge/Github-Pages-blue)](https://nehcg.github.io/algorithm-lovers/)

## Overview
Studying computer science invariably involves delving into algorithms. When I initially encountered concepts like greedy, divide and conquer, and dynamic programming, I found them challenging. However, I gradually developed a fascination for them. This interest grew particularly when I began incorporating these algorithms into my own projects, where the synergy between theory and practice fueled my enthusiasm.

Now, as a participant in competitive programming, I have developed novel algorithms in response to unique problems encountered during contests. Consequently, I have decided to build a web platform with two main objectives:

1. To share the algorithms I've developed, aiming to reach others with a passion for algorithms.
2. To establish a community for discussions about algorithms, encouraging the sharing of insights and opinions.

# Instruction to run the program

### Install Node.js

[Node.js](https://nodejs.org/en)

### Add a default.json file in config folder with the following

```json
{
  "mongoURI": "<your_mongoDB_Atlas_uri_with_credentials>",
  "jwtSecret": "secret"
}
```

### Install server dependencies

```bash
npm install
```

### Install client dependencies

```bash
cd client
npm install
```

### Create .env file to set environment variables

```bash
cd client
touch .env
echo "SKIP_PREFLIGHT_CHECK=true" >> .env
```

### Run the web platform locally from root

```bash
npm run dev
```

# Examples of how to use the application

Examples of API usage can be found in the [static website](https://nehcg.github.io/algorithm-lovers/), which includes specific instructions for usage.

After you run the web platform locally, the web application will launch on your ```localhost:3000```. It is very similar to the usual social network, with features such as registration, login, browsing, posting, etc.

**Home Page**: Application home page that allows users to register, log in, or browse published content by clicking the relevant button in the upper right conrner.

![](./img/homepage.png)

**Sign Up Page**: The user registration page, where users can create a new account.

![](./img/signup.png)

**Create Profile Page**: The profile creation page, where users can input and update their personal information, education, and work experience.

![](./img/create_profile.png)

**Sign In Page**: The login page, where users can enter their credentials to access their account.

![](./img/signin.png)

**Dashboard Page**: The main dashboard, where users can view an overview of their profile, posts, and other relevant information.

![](./img/dashboard.png)

**Post Page**: A single post page, users can create a post here.

![](./img/post.png)

**Published content Page**: A page showing a list of all posts in the application, allowing users to browse and interact with them.

![](./img/content.png)


##  Functionalites and APIs

### CREATE
- ```api/auth```: Register a new user or authenticate an existing user.
- ```api/posts```: Create a new post.
- ```api/posts/comment/:id```: Add a comment to a post.
- ```api/profile```: Create a user profile.
- ```api/users```: Register a new user.

### READ
- ```api/auth```: Authenticate a user and return their information.
- ```api/profile/me```: Retrieve the current user's profile.
- ```api/posts```: Retrieve a single post by its ID.
- ```api/posts/:id```: Retrieve a single post by its ID.
- ```api/profile```: Retrieve all user profiles.
- ```api/profile/user/:user_id```: Retrieve a specific user profile by its user ID.

### UPDATE
- ```api/posts/like/:id```: Like a post.
- ```api/posts/unlike/:id```: Unlike a post.
- ```api/profile/experience```: Add or update work experience in a user's profile.
- ```api/profile/education```: Add or update education in a user's profile.

### DELETE
- ```api/posts/:id```: Delete a post by its ID.
- ```/comment/:id/:comment_id```: Delete a comment from a post.
- ```api/profile```: Delete the current user's profile.
- ```api/profile/experience/:exp_id```: Delete a specific work experience from a user's profile.
- ```api/profile/education/:edu_id```: Delete a specific education entry from a user's profile.

# Contribute

Please see [CONTRIBUTING](./CONTRIBUTING.md)

---
_Source: https://npm.io/package/algorithm-lovers · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._