-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🎉 Create README.md and add the collabcode logo
- Loading branch information
0 parents
commit 2da9b8a
Showing
2 changed files
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
 | ||
|
||
# CollabCode Training | ||
|
||
An Open Source online course platform. | ||
|
||
## Getting Started | ||
|
||
1. Fork this repo and clone in your machine; | ||
|
||
2. Change directory to `collabcodetraining-api-email` where you cloned it; | ||
|
||
3. At the terminal, run: | ||
|
||
```bash | ||
npm install | ||
cp example.env .env | ||
npm run dev | ||
``` | ||
|
||
4. Open up [localhost:5001](http://localhost:5001) and start using it | ||
|
||
### Prerequisites | ||
|
||
- Npm | ||
- Node (>=10.16.3) | ||
|
||
## Running the tests | ||
|
||
```bash | ||
npm test | ||
``` | ||
|
||
## Running MongoDB with docker | ||
|
||
#### Prerequisites | ||
|
||
- Docker (>=1.13.1) | ||
|
||
Run the following command on the project root directory: | ||
|
||
```bash | ||
docker-compose up -d | ||
``` | ||
|
||
## Built With | ||
|
||
- [Restify](http://restify.com) | ||
|
||
## Contributing | ||
|
||
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. | ||
|
||
## Authors | ||
|
||
- **Joviane Jardim** - [@joviane](https://twitter.com/jovianejardim) | ||
- **Marco Bruno** - [@marcobrunobr](https://twitter.com/marcobrunobr) | ||
|
||
See also the list of [contributors](https://github.com/CollabCodeTech/collabcodetraining-api-auth/contributors) who participated in this project. | ||
|
||
## License | ||
|
||
This project is licensed under the MPL 2.0 License - see the [LICENSE](LICENSE.md) file for details | ||
|
||
## Acknowledgments | ||
|
||
Thanks to all members of CollabCode's community for the support! We love you! |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.