Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/andrianarivo/odin_members_only

Last synced: about 17 hours ago
JSON representation

Host: GitHub
URL: https://github.com/andrianarivo/odin_members_only
Owner: andrianarivo
License: mit
Created: 2023-08-16T07:50:23.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-08-17T08:33:39.000Z (over 1 year ago)
Last Synced: 2024-04-18T09:35:13.134Z (10 months ago)
Language: JavaScript
Size: 115 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



  

  


Members Only




# 📗 Table of Contents

- [📖 About the Project](#about-project)

    - [🛠 Built With](#built-with)

        - [Tech Stack](#tech-stack)

        - [Key Features](#key-features)

    - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

    - [Setup](#setup)

    - [Prerequisites](#prerequisites)

    - [Install](#install)

    - [Usage](#usage)

    - [Deployment](#deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Members Only 

**Members Only** is an exclusive clubhouse where members can write anonymous posts. Inside the clubhouse, members can

see who the author of a post is, but outside they can only see the story and wonder who wrote it.

## 🛠 Built With 

### Tech Stack 

  Server

  


    Express.js

  


Database

  


    MongoDB

  


### Key Features 

- **Sign In**

- **Sign Up**

- **Read Messages**

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://david-members-only.fly.dev/)

(back to top)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

- `NodeJS`

- `a code Editor (VSCode, Webstorm, etc.)`

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone https://github.com/andrianarivo/odin_members_only.git

```

### Install

Install this project with:

```sh

  cd my-project

  npm install

```

### Usage

To run the project, execute the following command:

```sh

  DEBUG=odin-members-only:*,app npm start

```

### Deployment

You can deploy this project using your own deployment solution

(back to top)


## 👥 Authors 

👤 **David**

- GitHub: [@andrianarivo](https://github.com/andrianarivo)

- Twitter: [@dandrianarivo](https://twitter.com/dandrianarivo)

- LinkedIn: [LinkedIn](https://linkedin.com/in/andrianarivo)

(back to top)


## 🔭 Future Features 

- [ ] **Updating messages**

- [ ] **Deleting messages**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project consider adding a ⭐️

(back to top)


## 🙏 Acknowledgments 

I would like to thank the Odin Project

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)