README.md

Ducktape

2 sec videos to share your daily life!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
   • Install the pwa
   • Add friends
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Create a Firebase project with Firestore, Auth and Storage for web. Keep the secret keys !
2. Clone the repo

   git clone https://github.com/alexandrelam/ducktape.git

3. Install NPM packages

   npm install

4. Enter your firebase secrets in .env.local

(back to top)

Usage

Install the PWA

You can install the pwa version of the app by adding it to the home screen using your web browser.

Add friends

The best way to add friends is by sharing your link.

Roadmap

• Optimize api calls
• Save your memories
• Make it easier to start developing

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Alexandre Lam - alexandrelam@outlook.com

Project Link: https://github.com/alexandrelam/ducktape

(back to top)