Code Monkey home page Code Monkey logo

ayan-biswas0412 / gssoc2021-hotelontouch Goto Github PK

View Code? Open in Web Editor NEW
67.0 1.0 79.0 1.87 MB

👨‍🔧👨‍🔧Manage your all hotel services at one place - This is the project repository for HotelOnTouch Project and this project is actively looking for new contributors👨‍🔧👩‍🏫

Home Page: https://hotelontouch.netlify.app

License: GNU General Public License v3.0

HTML 7.33% CSS 4.23% JavaScript 73.80% Starlark 0.73% Java 7.56% Ruby 0.98% Objective-C 5.38%
hotel-management-system reactjs expressjs react-bootstrap open-source first-timers-friendly reactnative firebase-auth looking-for-contributors gssoc21

gssoc2021-hotelontouch's Introduction

HotelOnTouch

CodeFactor Open Source Love svg1 PRs Welcome Maintenance GitHub Pull Request GitHub Issues GitHub Issues GitHub forks

forthebadge forthebadge forthebadge forthebadge

Project Description

In Today's Generation the Hotel Industries are changing rapidly so this platform will manage the in house needs of hotels like laundry service, Room Service Management, Bar, Restaurants Order Management.There will be one customer end system and hotel end system and customer can request hotel for one of the above service. We will use the basic ReactJS, MongoDB and ExpressJS for the web development purpose and the entire project will be open source and free to use for the end users. This project aims to give a hands on experience to the beginners in their open source journey

Project Modules

  1. Main Website(Main React Website)Netlify Status
  2. Customer Facing Mobile App (Android/IOS - development using React Native)
  3. Hotel Admin Facing Web App (Full Administrator access) Netlify Status
  4. Restaurant End Web App (Same for Bar and Equivalent services) Netlify Status
  5. Laundry End Web App
  6. On Demand service booking Web App (vary hotel to hotel basis)

Tech Stack

Frontend Development

React JS

Backend development (using mongoose framework)

Express.js MongoDB Mongoose

Rapid frontend development

React Bootstrap Library

Javascript Tests using automated scripts

JavaScript

Deployment to Cloud using Github Actions (Advance Stage work)

GitHub Actions

Contributing

This project is under active development

Please have a look at our Wiki to understand the contributing guidelines properly and to know the project better.

Also Please read our Contributing Guidelines, Code of Conduct thoroughly.If you are visiting this repo first time and you want to contribute to this repo as a participant or a mentor please complete the Onboarding Process

Main motto

To make a completely open sourced in house hotel management system

Useful Resources

Learning Resources 🧰

License

HotelOnTouch is licensed under the GNU General Public License v3.0. Learn more about it in the LICENSE file.

COVID-19Stay Home, Stay Safe!

I hope you are all staying safe at your home and enjoying the contribution for your awesome open source projects.

/**
 * Let's fight for Corona together!
 */
function stayAtHome() {
  eat();
  sleep();
  code();
  repeat();
}

while(_.isAlive(new Virus('COVID-19'))) {
  // Stay home, Stay safe
  stayAtHome();
}

👋 DO THE FIVE: Help stop coronavirus

  1. HANDS: Wash them often
  2. ELBOW: Cough into it
  3. FACE: Don't touch it
  4. SPACE: Keep safe distance
  5. HOME: Stay if you can

❌ Avoid Handshakes 🤝

✔️ Do Namastey 🙏


PS: I know it's off-topic but Yes, COVID-19 everyone's talking about. Please stay safe at your home and enjoy contributing to your projects.

Your friend,
Ayan :)

{thisRepo.url} = 'https://github.com/ayan-biswas0412/gssoc2021-HotelOnTouch/';

if (thisRepo.isAwesome()) {
  thisRepo.fork(); // waiting for your awesome contributions :)
  thisRepo.star(); // thanks in advance :p
  thisRepo.watch(bug => {
    if (!doesIssueExists(bug)) {
      createNewIssue(bug); // wow, that's a nice catch
    } else {
      checkIssueTracker(bug); // comment there
    }
  });
  thisRepo.share(); // sharing is caring :D
}

We are now a part of GSSoC 2021 !

GSSoC We got accepted for the GSSoC 2021 and actively looking for new participants,please feel free to ask questions in the discussion section of this repository and if you want to be our mentor please mention in the discussion.

Go to the Wiki for more information.

Our Contributors:

Credits goes to these people:✨

gssoc2021-hotelontouch's People

Contributors

abhishek7997 avatar aniketsingh98571 avatar anjali041 avatar ankita297 avatar ankitaugale23 avatar ayan-biswas0412 avatar chaimat avatar doringl avatar hsnice16 avatar janvimahajan14 avatar kajalsinghbaghel avatar khareyash05 avatar mohammedjameel24 avatar muditxofficial avatar nehathakur27 avatar rajeshpanjiyar avatar rohan-kulkarni-25 avatar sahuaman83 avatar sharvariiii avatar shreyanshi16 avatar singhayushh avatar tanay13 avatar tanyarajpal avatar vinit-churi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

gssoc2021-hotelontouch's Issues

make open source section in the website

Is your feature request related to a problem? Please describe.
Make one component open source programmes we are part of which can take a json as props the json should be as below

let openSource = [
{
"name" : "Girlscript Summer of Code 2021",
"url" :"gesso.tech",
"logo" : "logo_url" // either from web or imported locally
}
]

Describe the solution you'd like
the component should be under hotelontouch/src/components and should be named OpensourceProgramme.js

Additional context
You can use React Bootstrap Cards

make a feature section in main website

Is your feature request related to a problem? Please describe.
make a component SystemFeature.js inside hotelontouch and provide a proper svg from undraw and write one heading ```Completely Open Sourced Hotel Management System```` and under that add the project description by copying from Readme.

go to wiki addition

Is your feature request related to a problem? Please describe.

Add a line at the end of the Readme , Go the the Wiki for more info
and give this like as Click Here

Readme netlify badge error

Describe the bug
In the Readme, the netlify badges are showing the statuses of the last build (be it a PR preview deploy or a production main branch deploy ) but the expected behavior is it must show the latest main branch build status only

To Reproduce
Steps to reproduce the behavior:

  1. Go to Readme.md

Expected behavior
Only show the main branch deploy status

Screenshots
image

Add GSSoc 2021 logo in Readme

Is your feature request related to a problem? Please describe.
Add a logo of GSSoc 2021 in Readme file below the line we are now part of GSSoc 2021

Describe the solution you'd like
Follow proper markdown rules to add the logo and take the logo from GSSoc official website.
keep the logo asdocs/gsssoc2021_logo.png

Improve the Contribution section and fix the footer

Describe the bug
This isn't a bug, but the footer doesn't occupy 100% of the width on mobile devices. So I want to make it responsive. Also, want to enhance the contribution section as right now it occupies a lot of space since there are only 2 cards per row.

To Reproduce
Steps to reproduce the behavior:

Expected behavior
Footer to be responsive

Screenshots

Device Information [optional]:

Additional context

Are you working on this issue? (Yes/No)
Yes

Please assign this issue to me as a part of GSSOC21

Add cool svgs and make a section which describes the entire project

Is your feature request related to a problem? Please describe.
Read the project description from Readme and make one component AboutProject.js inside src/components in the folder hotelontouch which describes the entire project, use your own words , you can use cool animations or svgs to describe the project well.

Innovative ideas are most welcome

[Backend] Setting up the Service Schema

Issue Reference

View Issue Reference

About this issue

Following the user schema, the next focus is to set up the service schema. Services include laundry service, room service management, bar, restaurant order management etc as to be added by the admin.

hello

Give a basic intro about yourself
Testing

A clear and concise description of yourself [...]

Describe your tech expertise

A clear and concise description of the domains in which you have worked on (just make bullet points please don't provide information about each and every stack you can mention your previous projects but not necessary).

  • javascript
  • ReactJS
    ..etc

Describe your hour commitment per day to this project(optional)

A clear and concise description of any alternative solutions or features you've considered.

Your Social Links such that we can connect with you
Add as many as you can

If you have any query during the project work use this thread to communicate on general topics (non specific topics)

Design a logo for HotelOnTouch

Is your feature request related to a problem? Please describe.
Read the project description and be creative as much as you can, please attach your logos in this issue and best logo will be taken and shown in the website.Submit your logo in this comment thread

Make responsive navbar

Is your feature request related to a problem? Please describe.
The current navbar in the website is kind of old age type, make it such that it look good
edit the hotelontouch/src/components/NavbarComponent.js

make a GitHub status component

Is your feature request related to a problem? Please describe.
make a component inside src/components of folder hotelontouch for showing statuses of this repository , name the file GithubStatus.js and the function name should be GithubStatus and it should have the following props

  1. Github start
  2. Forks
  3. Github logo => onClick should redirect to this repo

Add a title project admin

Is your feature request related to a problem? Please describe.
Add a title project admin before the picture of the project admin edit the hotelontouch/src/components/AdminCard.js
and make UI improvement of the card if possible more interactive designs are welcome

Adding a Favicon in the title bar

Module: HotelOnTouch main website

Currently, there is react icon favicon present in the title bar. We want to change it to the logo of the project. The logo is present here. Also change the name of logo_shreyanshi16.png to logo.png.

Setup an authstack navigator in hotel-admin-frontend

Is your feature request related to a problem? Please describe.
make two sample routes Home.js and Dashboard.js and setup the authentication navigator for now just define authState by hardcoding userState say ``loggedInandloggedOut``` and based on that Home should be accessed in both modes but dashboard can only be accessed in logged in mode

Setup an express app and create folder backend

Is your feature request related to a problem? Please describe.
setup an initial express app using the standard method and just setup the app and run , add proper environment variable for PORTS and other things the expressapp should be under backend folder under the main repository.

name of the npm package should be : backendhotelontouch

Tech Stack Update ( LOGO add )

I will like to add tech stack logo used in our project this will make our project attractive !! Will start to work on this issue as soon as i get assigned !!

Add a try good first issue section in main website

Is your feature request related to a problem? Please describe.
Add a button in the main website which will have link to all the good first issues of this repository , show your creative work you may use svgs to make it cool , more innovative ideas are welcome feel free to suggest design

Setup React Router for hotel-admin-frontend

Describe the solution you'd like
Add routes for different pages make page_one.js and page_two.js and define their corresponding routes under src/App.js and also integrate React Bootstrap

all pages should be under src/pages

show one bootstrap in both of the pages containing text like This is the page one

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
NA

make a login page in hotel-admin-frontend

Is your feature request related to a problem? Please describe.
make one login page inside hotel-admin-frontend/src/pages and name it Login.js use React Bootstrap forms
there should be the following fields

1.Username
2.Password
3.Captcha Validation
4. Proper validation check for Valid Email formats in the Username Field
5. If captcha is not done then form can't be submitted
6. On Successful submission print the formdata in consul.log

make All contributors section in main website

Is your feature request related to a problem? Please describe.
make a component inside src/components of folder hotelontouch , name the file AllContributors.js and the function name should be AllContributors and it should show the following information

  1. Contributor Github Profile image
  2. Github username => Clickable => Redirect to their profile
  3. All contributors should be arranged in a way that old contributors remains on top
  4. Component should be responsive to screen size

Render the component in HomeScreen
Use Github API to fetch the list of contributors of this repository
See the website they have a contributors section

setup React router for hotel-restraunt-frontend

Describe the solution you'd like
Add routes for different pages make page_one.js and page_two.js and define their corresponding routes under src/App.js and also integrate React Bootstrap

all pages should be under src/pages

show one bootstrap in both of the pages containing text like This is the page one

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
NA

a merging flow needed

Is your feature request related to a problem? Please describe.
I think always merging to the main branch is an inefficient way for a long project like this I have thought a flow like this

participant PR -> (merge to) -> develop branch -> weekly merging to main
please put your views and take necessary steps (documentation updation in the wiki)

make our solutions section in the main website

Is your feature request related to a problem? Please describe.
make one our solution section and make one card inside it , give a proper svg , you can use undraw svgs
The Card title should be , Hotel Admin System and onClick should redirect to https://admin-hotelontouch.netlify.app make a beautiful card , more innovative designs are most welcome

Additional context
Use React Bootstrap Cards,
make component inside hotelontouch/src/components and name it OurSolutions.js and render it in homepage

Enhancement in the main website

Is your feature request related to a problem? Please describe.

Our Website is in the initial stage and all the development is done under the folder hotelontouch please go through that and we need more innovative ideas to make the website awesome , so more ideas are welcome here , please first discuss your idea in the comment and then if approved my a mentor then open an issue first and then start work on that . Please follow the mentioned steps otherwise your contribution will not be valid

cc @JanviMahajan14

Move Items in the Navbar to center

Describe the bug
On resizing the screen in the main website HotelOnTouch the Home section in the navbar aligns to left. We want to align the text in the center.

Steps to reproduce

  1. Run the HotelOnTouch module locally on the system.
  2. Resize the window
  3. See the bug in the Navbar for the Home section.

Expected behavior
Screenshot from 2021-03-09 17-54-39

[Backend] Setting up the Review and Badge Schema

Issue Reference

View Issue Reference

About this issue

Customers will have to option to review and rate the services and admins will have the feature the reward employees with badges for their work performance. Since these two models are relatively smaller and easier than User and Service, I have grouped them under a single issue. The work included: setting up two models - 1 for reviews and 1 for badges.

make a Pull request component

Is your feature request related to a problem? Please describe.
make a component inside src/components of folder hotelontouch for showing active PRs of this repository , name the file PullRequest.js and the function name should be PullRequest and it should have the following props

  1. PR link
  2. status = [merged/open/close]
  3. based on the status the colour of the component should change [purple/green/red].

also show some sample PRs in a page make a page inside src/pages and name that PullRequest.js

[Backend] Setting up the User Schema

Issue Reference

View Issue Reference

About this issue

Currently, there's just a dummy backend server setup for the project. To start with, the first focus must be setting up the user schema. As mentioned in the reference issue comment, there are to be three types of users - admin, employee and customer.
I will be working on the same - setting up models for all three type of users and sending a PR for your reviewing and amendments.

Make Contact us form

Is your feature request related to a problem? Please describe.
Make one blank contact us form which takes the following inputs
1.Name
2. Email
3. Message

Describe the solution you'd like
Make the component inside hotelontouch/src/components and name the component ContactUs.js the component should be good looking , more innovative ideas are welcome

Additional context
Use React Bootstrap Forms and give proper validation checks , ignore the form action part for now there should be blank action url for POST Request of the json , for now after form submit show the json in console.log

Enhance the Welcome to project section

Is your feature request related to a problem? Please describe.
Enhance the Welcome component add some cool svgs make responsive design if possible show your creativity, good animated designs are most welcome

make bottomNavigator is customerfrontend

Is your feature request related to a problem? Please describe.
you have to make an bootmnavigator consisting of four options

  1. Home
  2. Options
  3. About
  4. Profile

choose appropriate material icons and also in each page show one like "This is page_name page"

Setup React-Native-Paper before start working

typo in config.yml

Please be patient our project maintainers will be get back to you soon and till then you can differenct issues listed [here](https://github.com/ayan-biswas0412/gssoc2021-HotelOnTouch/issues)

change the line to : you can find different issues
check there is a typo

Enhance the We are a part of section

Is your feature request related to a problem? Please describe.

  1. Enlarge the text size of the We are a part of
  2. Make style improvements in the section, use some cool animations if possible

Add this label at the start of the Readme

Is your feature request related to a problem? Please describe.

CodeFactor

Just copy the below text to get the label

[![CodeFactor](https://www.codefactor.io/repository/github/ayan-biswas0412/gssoc2021-hotelontouch/badge)](https://www.codefactor.io/repository/github/ayan-biswas0412/gssoc2021-hotelontouch)

Add it at the first of the Readme file

make a wave animation based footer

Is your feature request related to a problem? Please describe.
make a component inside src/components of folder hotelontouch , name the file Footer.js and the function name should be Footer and it should have the link to the the Github Repository

Make the footer which looks nice, new and creative ideas are most welcome

Add our Solutions Section in the main website

Is your feature request related to a problem? Please describe.
make the component inside hotelontouch/src/components , Give the name OurSolution.js and use good svgs and small description (refer Readme) about the three project modules

  1. Hotel Guest App
  2. Hotel Admin App
  3. Hotel Services End App

Make a Project Admin Card Component

Is your feature request related to a problem? Please describe.
Add a project admin card component the card should contain
Project Admin Name : Ayan Biswas , Github Username : ayan-biswas0412 , Website : https://ayanbiswas.in and fetch the GitHub profile picture for the card

Name the component AdminCard.js , keep this in hotelontouch/src/components and render it in HomePage.js

Describe the solution you'd like
Use React Bootstrap Cards and make a good looking card
Innovative ideas are most welcome

Tentative Task List

  • Hotel Registration (In Admin Console)
  • Login system Development in Admin End
  • Hotel Admin Can create their profile
  • They Can add / remove rooms
  • Can create sub sections in hotel (restraunt/bar etc)
  • They Can create users and assign roles to various departments
  • Invoice Generation and Management
  • Login System Development in User End (in The mobile app)
  • Customer Registration (Automatic Upon check in to room)
  • Booking of Various Services via Customer App

[Backend] Basic User Endpoints

Issue Reference

View Issue Reference

About this issue

The various operations or functionalities to be covered:

  • CRUD users (as employee or customer)
  • Hotel Room booking
  • Admin routes to for making admin / removing admin (Users can only register as employees or customers. Only existing admins can add the admin role to others)

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.