📗 Table of Contents
📖 About the Project💻 Getting Started👥 Authors🔭 Future Features🤝 Contributing⭐️ Show your support🙏 Acknowledgements❓ FAQ📝 License
📖 GVASH PLANES
GVASH PLANES is a rails application where you can book planes. This app is created using
Rails
as an api andReact
as frontend with 5 people.
🛠 Project Links
Tech Stack
REACT
Server
Database
Key Features
- A user can register and log in, so that the data is private to them.
- Book new planes
- Create planes (only for admin)
Kanban Board
- Kanban-Board
- Kanban-Board initial screenshot
- At the end of this project, we are still 5 members: @Samuellekpor, @ginabeki, @Abdessittir, @heintayzar-hm, and @V-Blaze.
🚀 Live Demo
💻 Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
gem install
Setup
Clone this repository to your desired folder(Rails
):
git clone https://github.com/V-Blaze/GVASH-PLANES-API.git
Clone Another repository for frontend(React
). Project
git clone https://github.com/V-Blaze/gvash-planes.git
Install
Install Rails Project with:
cd GVASH-PLANES-API
bundle install
Setup database credentials
config/database.yml
rails db:setup
rails s
For the React project,
- Go to the respective folder where you clone.
- At the root folder of your app, Make new file called
.env
and add the following.
REACT_APP_API_URL=http://127.0.0.1:3000
- Run the following.
npm install
npm start
Authentication
if you wanna login as admin, you have to use the following credientials, please make sure to run above commands
email: user@example.com
password: password
Run tests
To run tests, run the following command:
rspec spec --format documentation
👥 Authors
- GitHub: @V-blaze
- Twitter: @blaze_valentine
- LinkedIn: @valentine-blaze
- GitHub: @Abdessittir
- Twitter: @AbdessittirHar1
- LinkedIn: Abdessittir Harkati
- GitHub: @gSamuellekpor
- Twitter: @samuel_lekpor
- LinkedIn: sammuel_kepor
🔭 Future Features
- Fully Functional Auth Pages including email verifications and forgot password pages
- Make multiple admins
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
If you like this project, Please give it a
🙏 Acknowledgments
Thanks @Murat Korkmaz on Behance. for providing this template
Thanks microvers for giving this oppournity.
📝 License
This project is MIT licensed.