achrafbou1 / tinypage

The open-source micro-site platform

Tinypage, the open-source micro-site platform

Getting started

To install Tinypage locally, follow our steps below or watch one of our available video installation guides! 👉

Pre-requisites

To install Tinypage, please ensure you have the following installed.

• PostgreSQL
• NPM/Node.JS
• Docker (optional)

Optionally, you can also provide API credentials for the following providers to enable additional features.

• Mixpanel (Event tracking)
• SimpleFileUpload (Avatar upload/file storage)

Setup with NPM

1. Clone the repository

git clone https://github.com/achrafbou1/Tinypage

2. Install the dependencies with NPM

cd api;npm install;cd ../editor;npm install;cd ../renderer;npm install;cd ../

3. Run the setup script

npm run setup

4. Build & launch Tinypage

Build all the modules

npm run build

Start the API in one terminal:

cd api; npm run start;

Start the editor in another terminal:

cd editor; PORT=8080 API_URL=http://localhost:5566 npm run start

Start the renderer in another terminal:

cd renderer; PORT=8081 API_URL=http://localhost:5566 npm run start

Development setup

The development setup is similar to the vanilla NPM setup, however comes with hot-reloading enabled.
🚨 This should not be used in production 🚨

1. Clone the repository

git clone https://github.com/achrafbou1/Tinypage

2. Install the dependencies with NPM

cd api;npm install;cd ../editor;npm install;cd ../renderer;npm install;cd ../

3. Run the setup script

npm run setup

4. Launch Tinypage with hot-reloading enabled

Start the API in one terminal:

cd api; npm run dev;

Start the editor in another terminal:

cd editor; PORT=8080 API_URL=http://localhost:5566 npm run dev

Start the renderer in another terminal:

cd renderer; PORT=8081 API_URL=http://localhost:5566 npm run dev

Screenshots

Roadmap

See our open issues to see what we're building next, alongside a list of known bugs and suggestions.
Don't see what you're looking for? Submit an issue!

Support

Need help? Our community support is online 9AM-5PM EST M-F, and our enterprise support team is available 24/7/365 via (email, through our Facebook page). Please don't hesitate to get in touch, we love to help and we're often able to resolve issues within the hour!

Contributing

You can visit our Feedback page to request any additional features or report bugs:

Being open-source, we welcome and encourage all contributions to our project.

To make your first contribution, follow these steps:

1. Fork the project
2. Create your new feature's branch
3. Make your changes
4. Commit your changes & push
5. Open a pull request

Acknowledgements

Special thanks to the Singlelink team for starting out the project and it's core features.

Our partners & sponsors

• BrowserStack (cross-browser UI/UX testing, sponsor)
• DigitalOcean (cloud hosting for developers, partner)

Singlelink team members

Tinypage team members

Tinypage, the open-source micro-site platform

Create your free micro-site in seconds at tinypage.app 👉