Skip to content

webdevtut/firecnc

Repository files navigation

Issues MIT License LinkedIn


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

[firecnc Screen Shot]

Basic House Rent App created for self-learning and showcase purpose.

Features :

  • Foolproof authentication and responsive for multiple screens 😄

  • Scalable image upload functionality (Cloudinary)

  • Hybrid App (one codebase for Android / ios / Web )

  • Infinite scrolling (Experimental)

(back to top)

Built With

Following Frameworks are used to make this project

  • Ionic
  • Angular
  • Typescript
  • RXJS
  • Capacitor
  • Node
  • NPM
  • Firebase

(back to top)

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

Install Node v14+

  • npm

    npm install npm@latest -g
  • Ionic CLI

    npm install -g @ionic/cli

Installation

  1. Clone the repo

    git clone https://github.com/webdevtut/firecnc.git
  2. Install NPM packages

    npm install
  3. Get Firebase Authentication Keys here

  4. Get Cloudinary Keys for image upload here

  5. In base folder run the command

    ionic serve
  6. To generate android build

  • First generate Angular Ionic build

    ionic build
  • Then generate Andoid build

    npx cap add android

(back to top)

Usage

Install apk provided in zip file here Create account and login to see the example🤗.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Create place to list for rent Functionality
  • Firebase Authentication Integration.
  • Image upload scalable with cloudinary.
  • Implement State management using RXJS (Reactive Login / Logout Functions)
  • Real time Firebase JSON Database integration
  • Multiple device support Camera Integration
  • Cancel Booking Functionality
  • Create Android Bundle (.APK) and upload as release
  • Add Features for User Accessibility
    • Google / Mapbox Map for place to rent location.
    • Contact and chat with Landlord

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

Your Name - @tushar-web-dev - tusharlookingforjob@gmail.com

Zipped APK Link: https://github.com/webdevtut/firecnc/files/11513724/firecandc.zip

(back to top)

Acknowledgments

Useful links

(back to top)