Altarian Pot

Table of Contents

• About Altarian Pot
  • Specifications
  • Roadmap
  • Built With
  • Security
    • Known Bugs
• Getting Started
  • Prerequisites
  • Installation
  • Testing
  • Usage
• API
• Contributing
• Contact
• Authors
• Licence
• Acknowledgments
• References

About Altarian Pot

Altarian Pot for birthday between students

This project is an opensource project, community driven by the students of 42Barcelona

Specifications

You can find here, more information about what the final product should look like

Roadmap

Hey, check the ROADMAP.md file to know everythings about how are we going to do

See the open issues for a list of proposed features.

Built-With

Any dependencies should go here, the less the better

Security

Known Bugs

Hopefully, this should be empty too

See the open issues for a list of known issues.

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

sudo apt-get update && sudo apt-get upgrade -y # Update your old computer

Installation

git clone https://github.com/42Barcelona/altarian-pot # Fetch source files

Testing

How does someone test the code ?

cd altarian-pot # Go in this famous directory
docker-compose up

Usage

How does someone use the code ?

cd altarian-pot # Go in this famous directory
docker-compose up

API

You can find API documentation at API.md

Contributing

How can you help ?

What are the guidelines to follow?

Please check the CONTRIBUTING.md file

Contact

Authors

• fscorcel - Initial design & development
• Mia - Initial design & specs

See also the list of contributors who participated in this project.

Licence

License - see the LICENSE file for details

Acknowledgments

Thanks to:

• All people spending their time to make a better world
• [email protected] & 42 Barcelona students for their ideas & expectations

References

• https://google.com
• https://candidatura.42barcelona.com
• https://api.intra.42.fr