https://github.com/diabolusgx/newsletter-subscription

lets you create new subscription and list all subscriptions
https://github.com/diabolusgx/newsletter-subscription

Last synced: 15 days ago
JSON representation

lets you create new subscription and list all subscriptions

• Host: GitHub
• URL: https://github.com/diabolusgx/newsletter-subscription
• Owner: DiabolusGX
• Created: 2021-08-06T08:02:35.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T07:36:43.000Z (almost 2 years ago)
• Last Synced: 2024-11-09T22:42:42.623Z (2 months ago)
• Language: JavaScript
• Size: 4.8 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# newsletter Subscription

This repository contains source code for newsletter Subscription using ReactJS + Tailwind + Expressjs + MongoDB (with mongoose ODM) that lets you create new subscription and list all subscriptions that shows name, email and createdAt time of that subscription.

### 🔗 [Demo Video](https://vimeo.com/583754613)

[![Demo Screenshot](https://raw.githubusercontent.com/DiabolusGX/newsletter-subscription/master/demo/demo.png)](https://raw.githubusercontent.com/DiabolusGX/newsletter-subscription/master/demo/demo.png)

## Index

-   [Requirements](#Requirements)

-   [Installation](#Installation)

-   [Configuration](#Configuration)

## Getting Started

This reposetory only contains both backend + frontend so you need to install both.

There are scripts to make it easy for you.

### Requirements

This module requires the following modules:

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

-   [Yarn](https://classic.yarnpkg.com/en/docs/install/#windows-stable)

-   [Git](https://git-scm.com/downloads)

### Installation

To clone the backend and serve it locally, where `newsletter-subscription` is the name of the repository:

```shell

$ git clone https://github.com/DiabolusGX/newsletter-subscription.git my-newsletter-subscription

$ cd my-newsletter-subscription

```

This will take you to the clonned project directory and ready to configure the project.

## Configuration

-   You have to add `.env` in `server` folder of the project where you have to add `MONGO_URI` (please contact me to get it) and `PORT` (default is `3001`) Also, please make sure to change `proxy` in client `package.json` if you another port.

    ```shell

    PORT=3001

    MONGO_URI=mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]

    ```

    `PORT` is set to `3001` by default but you MUST enter valid [`MONGO_URI`](https://docs.mongodb.com/manual/reference/connection-string/) (either mongo atlas cluster or localhost) for application to start and work properly.

    > If the username or password includes the `: / ? # [ ] @` characters,

    > those characters must be converted using [percent encoding](https://datatracker.ietf.org/doc/html/rfc3986#section-2.1).

After you've setup enviornment variables, you can continue with installing dependencies :

-   Run to install all rependencies, _please use custom script to install dependencies_.

    ```shell

    yarn install

    ```

-   Run to start the development server that'll run on `PORT` mentioned in `.env` file (or 3000 be default).

    ```shell

    yarn start

    ```

-   **OR** you an use `yarn client` or `yarn server` to start independently.

---

## Additional help

Please reachout to me anytime on [discord](https://boosterbot.xyz/support) or by mail 🙏