Code Monkey home page Code Monkey logo

wallx's Introduction

Wallx

Contributors Forks Issues Pull Request

.

Contents

  1. Description
  2. Project structure
  3. Project roadmap
  4. Getting started
  5. Live demo
  6. Built with
  7. Contributing
  8. Authors
  9. License
  10. Acknowledgments

Description

The idea

Wallx provides a wide range of wallpapers from the Unsplash library. the app also orders the pictures by preference and lets the user set the desired picture as lock, home screen wallpaper, or both.

Project structure

+---lib
|   +---controller            (contain files that controls the child widgets)
|   +---model                 (files containing wallpapers and URL classes)
|   +---service               (holds the file for the rest API )
|   \---view
|       +---screens           (UI code for the two screens)
|       +---utils             (codes for shared grid widgets, color constants and button styles)
|       |   +---constants     
|       |   +---helpers       
|       |   \---shared        
|       \---wigets 
|  +---main.dart              (contains the main function for the execution of the program)          

Project roadmap

The project currently does the following things.

  • fetches necessary data from the Unsplash API to display the wallpapers.
  • orders the pictures according to preferences.
  • lets the user set any desired picture as the home and lock screen wallpaper.

See below for our future steps.

  • splash screen overhaul
  • animating the search bar
  • adding new functionality wallpaper_view page

Getting started

Prerequisites

  1. Basic Understanding of Programming Language (preferably, C++/Java)
  2. OOPS
  3. Understanding of the Flutter Framework by Google

Installing

Softwares needed

Knowledge needed

The best way to learn the following is to google each and everything!

  • Fundamental understanding of Git and GitHub:

    • What are repositories (local - remote - upstream), issues, pull requests
    • How to clone a repository, how to fork a repository, how to set upstreams
    • Adding, committing, pulling, and pushing changes to remote repositories
  • For Flutter SDK:

    • Getting Started with Flutter

    • Beginner to Intermediate knowledge of Flutter UI Design Patterns, Widgets, Routers, Navigation, etc.

    • Knowledge of integrating third-party libraries and Hive database (for solving backend issues, not mandatory).

Instructions

Below is a step-by-step series of instructions that tells you how to run the project locally. Google every issue you face following the below instructions or just ask us in our Discord channel.

  • Fork and Clone the Repository
  • Use Visual Studio Code/Android Studio
  • In the terminal type flutter pub get
  • Type flutter run in Terminal / Choose Run --> Run without Debugging and play it in any emulator of your choice(Special Note: Do not run it in WEB mode as Shared Preferences is there.)

Live demo

Built with

Contributing

Please read contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

wallx's People

Contributors

sahilrik avatar adiii1436 avatar maruti54 avatar

Stargazers

 avatar

wallx's Issues

Add a like button

add a circular "like" button to the wallpaper view page to the left of the set button

add snackbar and functionality to the like and download button

on tapping the like button it should change the state of the button (to a liked state eg - from a hollow outlined to a filled button) and show a snack bar with a message.

on tapping the download button it should download the image (u should be able to find the image in the gallery) and show a snack bar with the message "image successfully downloaded".

Animate the search button

on tapping the search button on the home view page it should expand into a rounded-edged search bar with a few suggestions for frequent searches.

splash screen overhaul

make a beautiful splash screen with the image provided in the asset folder, and add any desired animation to it.

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.