Giter Site home page Giter Site logo

cardmesh / web-app Goto Github PK

View Code? Open in Web Editor NEW
8.0 1.0 5.0 909 KB

Web app repository for CardMesh.

License: MIT License

JavaScript 17.06% HTML 0.90% SCSS 2.65% CSS 1.01% Svelte 77.86% Dockerfile 0.53%
business-card card digital-business-card nfc

web-app's Introduction

Web app for CardMesh

CI status Contributors Forks Stargazers Issues MIT License

CardMesh is an app aimed at modernizing the sharing of business cards within a company. It displays digital business cards in a web browser, accessible via NFC tags, QR codes, or direct URLs.

Tech Stack

HTML5 CSS3 Sass Javascript Node.Js Svelte Vite Bootstrap npm Docker

Versions & Dependencies

Version Documentation
1.0.4 current

Requirements

  • Node.js >= 18.x

Documentation

Steps to setup

1. Clone the application

git clone [email protected]:CardMesh/web-app.git && cd web-app

2. Configure your private .env file, following the .env.example sample

3. In svelte.config.js you can define the adapter. If you want to run this on a node server, use:

import adapter from '@sveltejs/adapter-node';

4. Run the app

npm run dev # dev
npm run build && npm run preview # dev
npm run build && npm run start # prod

Docker

If you're considering deploying using docker-compose, here's a simple example. Please see ./docker-compose.yml.

docker-compose up -d

Roadmap

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

Contributing

If you have a suggestion to enhance this project, kindly fork the repository and create a pull request. Alternatively, you may open an issue and tag it as "enhancement". Lastly, do not hesitate to give the project a star โญ. Thank you for your support.

Tools

Coding standards checker:

npm run lint

Coding standards fixer:

npm run format

Unit tests:

npm run test

Build tools

Move bootstrap to ./static. Used when bootstrap is updated:

npm run build:bootstrap

Build all favicons:

npm run build:favicons

License

The distribution of the package operates under the MIT License. Further information can be found in the LICENSE file.

DISCLAIMER: USE OF THIS GITHUB REPOSITORY

By accessing and using this GitHub repository ("Repository"), you agree to the following terms and conditions. If you do not agree with any of these terms, please refrain from using the Repository.

  1. No Warranty or Liability: The Repository is provided on an "as is" basis, without any warranties or representations of any kind, either expressed or implied. The owner(s) of the Repository ("Owner") hereby disclaim(s) any and all liability for any damages, losses, or injuries arising out of or in connection with the use, inability to use, or reliance on the Repository.

  2. No Legal Advice: The content and information provided in the Repository are for informational purposes only and do not constitute legal advice. The Owner does not assume any responsibility for any actions taken or not taken based on the information provided in the Repository. For legal advice or specific inquiries, consult a qualified legal professional.

  3. Intellectual Property: The Repository may contain copyrighted materials, including but not limited to code, documentation, images, and other intellectual property owned by the Owner or third parties. You may not use, copy, distribute, or modify any such materials without obtaining prior written permission from the respective copyright holder(s).

  4. External Links: The Repository may include links to third-party websites or resources. The Owner does not endorse, control, or assume any responsibility for the content or practices of these third-party websites or resources. Accessing and using such links are solely at your own risk.

  5. Modification of Repository: The Owner reserves the right to modify, update, or remove any content or functionality of the Repository at any time without prior notice. The Owner shall not be liable for any consequences arising from such modifications.

  6. Indemnification: You agree to indemnify and hold the Owner harmless from and against any claims, damages, liabilities, costs, and expenses arising out of or in connection with your use of the Repository, including but not limited to any violation of these terms.

  7. Governing Law: These terms shall be governed by and construed in accordance with the laws of the jurisdiction where the Owner is located, without regard to its conflict of law principles.

By using the Repository, you acknowledge that you have read, understood, and agreed to these terms and conditions. If you do not agree with any of these terms, your sole remedy is to discontinue using the Repository.

web-app's People

Contributors

dependabot[bot] avatar mathiasreker avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

web-app's Issues

Option to recieve email n days in the future

Is your feature request related to a problem? Please describe.
I need the ability to schedule and receive an email notification n days in the future.

Describe the solution you'd like
I would like to have an option to schedule an email notification to be sent to a specific recipient(s) n days in the future. This feature would allow me to set a future date for the email and specify the number of days in advance when the email should be sent. The email should be delivered automatically on the scheduled date without any manual intervention.

Describe alternatives you've considered
~

Additional context
~

Integrate with https://cal.com

Is your feature request related to a problem? Please describe.
I would like to integrate with https://cal.com/.

Describe the solution you'd like
I want an interface to the service.

Describe alternatives you've considered
~

Additional context
~

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.