Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/SySagar/Pensdown into trans…
Browse files Browse the repository at this point in the history
…late
  • Loading branch information
SySagar committed Sep 24, 2023
2 parents e2d84cd + 75f5267 commit 55333e4
Showing 1 changed file with 62 additions and 2 deletions.
64 changes: 62 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,62 @@
# Pensdown
Pensdown : A blogging app where writers can come and express their thoughts and ideas to the world.
<div align="center">
<img src="https://raw.githubusercontent.com/SySagar/Pensdown/63b09800ed43fa24a5b0d9b2c0910d1ea5d8b520/public/vite.svg" href="https://github.com/SySagar/Pensdown" width="128" height="128" style="display: block; margin: 0 auto"/>
<h1>Pensdown</h1>
<h3><p>A full fledged blogging website where writers and authors from all around the world can come and express their ideas via a digital medium. Pensdown decreases the bridging gap between content consumers and creators by allowing impartial expression of ideas without any intervening forces.</p></h3>

![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)
![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)
![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)
![Firebase](https://img.shields.io/badge/firebase-%23039BE5.svg?style=for-the-badge&logo=firebase)
![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)
![Azure](https://img.shields.io/badge/azure-%230072C6.svg?style=for-the-badge&logo=microsoftazure&logoColor=white)
![Terraform](https://img.shields.io/badge/terraform-%235835CC.svg?style=for-the-badge&logo=terraform&logoColor=white)

</div>

---

<p>
<img src="https://raw.githubusercontent.com/SySagar/Pensdown/main/snaps/Capture2.PNG" width="500" height="240" />
<img src="https://raw.githubusercontent.com/SySagar/Pensdown/main/snaps/Capture.PNG" width="500" height="240" />
<img src="https://raw.githubusercontent.com/SySagar/Pensdown/main/snaps/Capture3.PNG" width="500" height="240" />
</p>

## Features
- Comprises a rich text editor where you can write anything
- Community Forums and Discussion Boards for creators and consumers
- Implements likes , comments and follow system
- voice search
- Language translation
- Has a robust notification system
- Authentication and authorization
- Interactive UI


Check out the releases to visit the website url or simply get it in the about section.

## Development setup
### Tools
- VS-code
- Docker
- Typescript

### Setup
- Clone the repository.
- Open a fresh terminal in the cloned project and hit `npm install`
- start the development server using `npm run dev`
- This would start vite server at port 5173

## Known problems
none

## Contributions
There's a huge room for improvements! Please open an issue to report bugs, discuss ideas and so on.

Check out the repo's [issue backlog](https://github.com/SySagar/Pensdown/issues) for source requests and bug reports.


## Please Share & Star the repository. This motivates me a lot :)

0 comments on commit 55333e4

Please sign in to comment.