Skip to content

Latest commit

 

History

History
154 lines (101 loc) · 4.32 KB

README.md

File metadata and controls

154 lines (101 loc) · 4.32 KB
Raw

WeddIn logo with text

Organize your wedding event and guest list.

Create a digital custom invitation card for your wedding with WeddIn and send the link to your guests. Playfully build a website with all the content around your event, without any programming knowledge.

Documentation · Live Demo

WeddIn Server

Your backbone for the perfect wedding. A responsive user friendly ui to setup your personal wedding page. It's damn simple and easy. Just add our guest and information to the database and send the links to your guest.

All without coding! Just configuration. For a deeper look what you can set up and how it works, visit weddin.site/doc.

Table of Content

🚀 Getting started

# install dependencies
$ npm install

# serve with hot reload at localhost:1337
$ npm run develop

After that you can visit http://localhost:1337/admin and start setup you server with the ui.

In case you don't want to setup the data from scratch - the repo provide you with 2 diffrent demo data for an easy start - which can be used for local development as well as production - see 🗄️ Startup Data.

Don't forget the WeddIn Client - to see your results and that your guest can sign in for your awesome wedding!

🗄️ Startup Data

n the folder res you will find two different startup types

  • Demo: filled with a lot of dummy data - perfect for test and developing
  • Init: minimal db with all important stuff and some introduction - perfect for production as a db for a new site

Demo Data

  • stop the server
  • copy res/demo/db/data.db to .tmp.
  • copy res/demo/uploads/ to public/uploads/.
  • restart the server

Credentials to log in can be found below.

Init Data

  • stop the server
  • copy res/init/db/data.db to .tmp.
  • restart the server

Credentials to log in can be found below.

Credentials Backend

Admin

User: [email protected]

PW: AdminWeddin1

Editor/Author

User: [email protected]

PW: DemoWeddin1

Credentials Client

Wedding couple

Code: brautpaar

Dummy Guest

Code: test

🚢 Deploy

Create a .env file in root and fill have a look at env.example.

After that build the server and start.

$ npm run build
$ npm run start

Run Production Mode

yarn is recommended

$ NODE_ENV=production yarn build

# just fot test it is works
$ NODE_ENV=production yarn start

# use pm2 to run as service in background - NOT boot save just for test pm2
$ NODE_ENV=production pm2 start server.js --name XXXX.content.weddin.site

# best practice: use pm2 to run as service an in background - BOOT save
# add in  /root/ecosystem.config the new app - looks like:
# {
#   name: "demo.content.weddin.site",
#   cwd: "/var/www/demo.content.weddin.site/",
#   script: "./server.js",
#   env: {
#     NODE_ENV: "production",
#   },
# }

# then run it with
$ pm2 start ecosystem.config

🧾 License

You can copy the source code, edit it and build totally new projects with it. But however you are not allowed to use the code for commercial use.

See the LICENSE file for more licensing information.

🚫 Disclaimer

YOUR ARE FREE TO USE THE CODE IN YOUR PROJECTS HOWEVER MAKE CLEAR THAT THE CODE IS OFFERED "AS-IS, WITHOUT WARRANTY AND DISCLAIMING LIABILITY FOR DAMAGES RESULTING FROM USING THE CODE.