Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 2.33 KB

README.md

File metadata and controls

60 lines (36 loc) · 2.33 KB

AlwaysUpdate ~ Backend 📰

Always Update

AlwaysNews is an e-NewsPaper from Argentina, Colombia, Venezuela and Mexico, that update its news every day.

getting started 🚀

Things that you need: 🛠️

  • MongoDB
  • Mailgun account or any other service to send mails 😋

Interesant features 🧨✨🎉

  • Email verification 📩
  • News are updated automatically cuz the app is connected to a web scrapper that made the "hard work" 🕷🕸
  • Also, admins have an option to see what are the topics that have more interest by the users 📊
  • Well there is 2 type of users: "Normal user" and "Admin user" 👥

Configuration 🔧

There is an example of the ".env" file, you just have to add there your values, raname ".env.example" to ".env" and the app will work perfectly

Install 🎻🎸🎺

npm install

Command to run on dev mode 💻

npm run dev

Command to run tests 📎

npm tests

API 🌈

HERE you will have fully documentation of every endpoint of the api.

Contributing ✒️

Pull requests are welcome!. And if you have an idea for a feature and dont have time to do this, feel free to open a issue!

Deployment

https://easynews.tech

Demo

Alt text for your video

License 📄

MIT