Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 1.75 KB

README.md

File metadata and controls

57 lines (44 loc) · 1.75 KB
Raw

Newsletter Subscription 🗞️

A Full Stack Web App demonstrating a form which allows users to subscribe to newsletter via their email and view list of all subscribers. The subscriptions get recorded in a database and accessible via a RESTFul JSON API.

demo-gif

Tech Stack Used 🛠️

Front End:

Specification Description
Language TypeScript
Technology React JS
UI Tailwind CSS
State Redux
Form React Hooks Form
Linter ESLint
Formatted Prettier

Back End:

Specification Description
Language TypeScript
Technology Express JS
ENV Vars Validator JOI
Security Module Helmet
Request Params Validator Express Validator
Database MongoDB
ODM Library Mongoose
Linter ESLint
Formatted Prettier

Steps to run 🚀

Note: You'll need to configure env vars explicitly as per example env files in both client and server.

  # clone the repository
  git clone https://github.com/vinaysharma14/newletter-subscription

  # navigate to the project
  cd newsletter-subscription

  # open server, install dependencies and run
  cd client
  npm install
  npm run

  # open client and install dependencies and run
  cd server
  npm install
  npm run