Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/01zulfi/pals-only
An express application where users (authenticate via passportjs) can read and post messages
https://github.com/01zulfi/pals-only
express mongodb passport-local passportjs pug tailwindcss
Last synced: 16 days ago
JSON representation
An express application where users (authenticate via passportjs) can read and post messages
- Host: GitHub
- URL: https://github.com/01zulfi/pals-only
- Owner: 01zulfi
- License: mit
- Created: 2022-05-04T08:28:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-15T08:14:19.000Z (7 months ago)
- Last Synced: 2024-12-09T10:49:22.625Z (19 days ago)
- Topics: express, mongodb, passport-local, passportjs, pug, tailwindcss
- Language: CSS
- Homepage: https://pals-only.adaptable.app/
- Size: 365 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pals Only
### [Pals Only Preview Link](https://pals-only.adaptable.app/)
## About
A message board application where users authenticate themselves via Passport.js. Authenticated users can post new messages. Users become members by entering a secret passcode in the [Member form](https://pals-only.herokuapp.com/users/member). Members can see the author of the message and view their profiles. If they wish, users can become admins by entering a secret passcode in the [Admin form](https://pals-only.herokuapp.com/users/admin). Admins can delete any message.
## Technologies
- Written in a NodeJS Framwork: [Express](https://expressjs.com/)
- Employes a Model, View, Controller architecture
- Authenticates users with [Passport.js](https://www.passportjs.org/)'s local strategy
- Uses [Pug](https://pugjs.org/api/getting-started.html) as the templating engine
- Styled via [Tailwind CSS](https://tailwindcss.com/)
## Setting up Locally
1. Clone this repository:
```bash
git clone [email protected]:01zulfi/pals-only.git
```
2. Install dependences:
```bash
npm install
```
3. Create a database on [MongoDB](https://www.mongodb.com/).
4. Create a `.env` file with the following:
```
MONGODB_URL="your mongodb connection url here"
SECRET="any random long string here"
```
5. Start the server:
```bash
npm run serverstart
```
## Attributions
- Favicon from [svgrepo.com](https://www.svgrepo.com/)
- Color palette from [dracula](https://draculatheme.com/contribute)
----
